1 /*
2 * Copyright (c) 2016, 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/aotLogging.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/classLoaderExt.hpp"
34 #include "classfile/javaAssertions.hpp"
35 #include "classfile/javaClasses.hpp"
36 #include "classfile/javaClasses.inline.hpp"
37 #include "classfile/moduleEntry.hpp"
38 #include "classfile/modules.hpp"
39 #include "classfile/packageEntry.hpp"
40 #include "classfile/stringTable.hpp"
41 #include "classfile/symbolTable.hpp"
42 #include "classfile/systemDictionary.hpp"
43 #include "classfile/vmClasses.hpp"
44 #include "classfile/vmSymbols.hpp"
45 #include "jvm.h"
46 #include "logging/log.hpp"
47 #include "logging/logStream.hpp"
48 #include "memory/resourceArea.hpp"
49 #include "prims/jvmtiExport.hpp"
50 #include "runtime/arguments.hpp"
51 #include "runtime/globals_extension.hpp"
52 #include "runtime/handles.inline.hpp"
53 #include "runtime/javaCalls.hpp"
54 #include "runtime/jniHandles.inline.hpp"
55 #include "utilities/formatBuffer.hpp"
56 #include "utilities/stringUtils.hpp"
57 #include "utilities/utf8.hpp"
58
59 static bool verify_module_name(const char *module_name, int len) {
60 assert(module_name != nullptr, "invariant");
61 return (len > 0 && len <= Symbol::max_length());
62 }
63
64 static bool verify_package_name(const char* package_name, int len) {
65 assert(package_name != nullptr, "Package name derived from non-null jstring can't be null");
66 return (len > 0 && len <= Symbol::max_length() &&
67 ClassFileParser::verify_unqualified_name(package_name, len,
68 ClassFileParser::LegalClass));
69 }
70
71 static char* get_module_name(oop module, int& len, TRAPS) {
72 oop name_oop = java_lang_Module::name(module);
73 if (name_oop == nullptr) {
74 THROW_MSG_NULL(vmSymbols::java_lang_NullPointerException(), "Null module name");
75 }
76 size_t utf8_len;
77 char* module_name = java_lang_String::as_utf8_string(name_oop, utf8_len);
78 len = checked_cast<int>(utf8_len); // module names are < 64K
79 if (!verify_module_name(module_name, len)) {
80 THROW_MSG_NULL(vmSymbols::java_lang_IllegalArgumentException(),
81 err_msg("Invalid module name: %s", module_name));
82 }
83 return module_name;
84 }
85
86 static Symbol* as_symbol(jstring str_object) {
87 if (str_object == nullptr) {
88 return nullptr;
89 }
90 size_t len;
91 char* str = java_lang_String::as_utf8_string(JNIHandles::resolve_non_null(str_object), len);
92 return SymbolTable::new_symbol(str, checked_cast<int>(len));
93 }
94
95 ModuleEntryTable* Modules::get_module_entry_table(Handle h_loader) {
96 // This code can be called during start-up, before the classLoader's classLoader data got
97 // created. So, call register_loader() to make sure the classLoader data gets created.
98 ClassLoaderData *loader_cld = SystemDictionary::register_loader(h_loader);
99 return loader_cld->modules();
100 }
101
102 static PackageEntryTable* get_package_entry_table(Handle h_loader) {
103 // This code can be called during start-up, before the classLoader's classLoader data got
104 // created. So, call register_loader() to make sure the classLoader data gets created.
105 ClassLoaderData *loader_cld = SystemDictionary::register_loader(h_loader);
106 return loader_cld->packages();
107 }
108
109 static ModuleEntry* get_module_entry(Handle module, TRAPS) {
110 if (!java_lang_Module::is_instance(module())) {
111 THROW_MSG_NULL(vmSymbols::java_lang_IllegalArgumentException(),
112 "module is not an instance of type java.lang.Module");
113 }
114 return java_lang_Module::module_entry(module());
115 }
116
117
118 static PackageEntry* get_locked_package_entry(ModuleEntry* module_entry, const char* package_name, int len) {
119 assert(Module_lock->owned_by_self(), "should have the Module_lock");
120 assert(package_name != nullptr, "Precondition");
121 TempNewSymbol pkg_symbol = SymbolTable::new_symbol(package_name, len);
122 PackageEntryTable* package_entry_table = module_entry->loader_data()->packages();
123 assert(package_entry_table != nullptr, "Unexpected null package entry table");
124 PackageEntry* package_entry = package_entry_table->locked_lookup_only(pkg_symbol);
125 assert(package_entry == nullptr || package_entry->module() == module_entry, "Unexpectedly found a package linked to another module");
126 return package_entry;
127 }
128
129 static PackageEntry* get_package_entry_by_name(Symbol* package, Handle h_loader) {
130 if (package != nullptr) {
131 PackageEntryTable* const package_entry_table =
132 get_package_entry_table(h_loader);
133 assert(package_entry_table != nullptr, "Unexpected null package entry table");
134 return package_entry_table->lookup_only(package);
135 }
136 return nullptr;
137 }
138
139 bool Modules::is_package_defined(Symbol* package, Handle h_loader) {
140 PackageEntry* res = get_package_entry_by_name(package, h_loader);
141 return res != nullptr;
142 }
143
144 // Converts the String oop to an internal package
145 // Will use the provided buffer if it's sufficiently large, otherwise allocates
146 // a resource array
147 // The length of the resulting string will be assigned to utf8_len
148 static const char* as_internal_package(oop package_string, char* buf, size_t buflen, int& utf8_len) {
149 size_t full_utf8_len;
150 char* package_name = java_lang_String::as_utf8_string_full(package_string, buf, buflen, full_utf8_len);
151 utf8_len = checked_cast<int>(full_utf8_len); // package names are < 64K
152
153 // Turn all '/'s into '.'s
154 for (int index = 0; index < utf8_len; index++) {
155 if (package_name[index] == JVM_SIGNATURE_DOT) {
156 package_name[index] = JVM_SIGNATURE_SLASH;
157 }
158 }
159 return package_name;
160 }
161
162 static void define_javabase_module(Handle module_handle, jstring version, jstring location,
163 objArrayHandle pkgs, int num_packages, TRAPS) {
164 ResourceMark rm(THREAD);
165
166 // Obtain java.base's module version
167 TempNewSymbol version_symbol = as_symbol(version);
168
169 // Obtain java.base's location
170 TempNewSymbol location_symbol = as_symbol(location);
171
172 // Check that the packages are syntactically ok.
173 char buf[128];
174 GrowableArray<Symbol*>* pkg_list = new GrowableArray<Symbol*>(num_packages);
175 for (int x = 0; x < num_packages; x++) {
176 oop pkg_str = pkgs->obj_at(x);
177
178 if (pkg_str == nullptr || pkg_str->klass() != vmClasses::String_klass()) {
179 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
180 err_msg("Bad package name"));
181 }
182
183 int package_len;
184 const char* package_name = as_internal_package(pkg_str, buf, sizeof(buf), package_len);
185 if (!verify_package_name(package_name, package_len)) {
186 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
187 err_msg("Invalid package name: %s for module: " JAVA_BASE_NAME, package_name));
188 }
189 Symbol* pkg_symbol = SymbolTable::new_symbol(package_name, package_len);
190 pkg_list->append(pkg_symbol);
191 }
192
193 // Validate java_base's loader is the boot loader.
194 oop loader = java_lang_Module::loader(module_handle());
195 if (loader != nullptr) {
196 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
197 "Class loader must be the boot class loader");
198 }
199 Handle h_loader(THREAD, loader);
200
201 // Ensure the boot loader's PackageEntryTable has been created
202 PackageEntryTable* package_table = get_package_entry_table(h_loader);
203 assert(pkg_list->length() == 0 || package_table != nullptr, "Bad package_table");
204
205 // Ensure java.base's ModuleEntry has been created
206 assert(ModuleEntryTable::javabase_moduleEntry() != nullptr, "No ModuleEntry for " JAVA_BASE_NAME);
207
208 bool duplicate_javabase = false;
209 {
210 MutexLocker m1(THREAD, Module_lock);
211
212 if (ModuleEntryTable::javabase_defined()) {
213 duplicate_javabase = true;
214 } else {
215
216 // Verify that all java.base packages created during bootstrapping are in
217 // pkg_list. If any are not in pkg_list, than a non-java.base class was
218 // loaded erroneously pre java.base module definition.
219 package_table->verify_javabase_packages(pkg_list);
220
221 // loop through and add any new packages for java.base
222 for (int x = 0; x < pkg_list->length(); x++) {
223 // Some of java.base's packages were added early in bootstrapping, ignore duplicates.
224 package_table->locked_create_entry_if_absent(pkg_list->at(x),
225 ModuleEntryTable::javabase_moduleEntry());
226 assert(package_table->locked_lookup_only(pkg_list->at(x)) != nullptr,
227 "Unable to create a " JAVA_BASE_NAME " package entry");
228 // Unable to have a GrowableArray of TempNewSymbol. Must decrement the refcount of
229 // the Symbol* that was created above for each package. The refcount was incremented
230 // by SymbolTable::new_symbol and as well by the PackageEntry creation.
231 pkg_list->at(x)->decrement_refcount();
232 }
233
234 // Finish defining java.base's ModuleEntry
235 ModuleEntryTable::finalize_javabase(module_handle, version_symbol, location_symbol);
236 }
237 }
238 if (duplicate_javabase) {
239 THROW_MSG(vmSymbols::java_lang_InternalError(),
240 "Module " JAVA_BASE_NAME " is already defined");
241 }
242
243 // Only the thread that actually defined the base module will get here,
244 // so no locking is needed.
245
246 // Patch any previously loaded class's module field with java.base's java.lang.Module.
247 ModuleEntryTable::patch_javabase_entries(THREAD, module_handle);
248
249 log_info(module, load)(JAVA_BASE_NAME " location: %s",
250 location_symbol != nullptr ? location_symbol->as_C_string() : "nullptr");
251 log_debug(module)("define_javabase_module(): Definition of module: "
252 JAVA_BASE_NAME ", version: %s, location: %s, package #: %d",
253 version_symbol != nullptr ? version_symbol->as_C_string() : "nullptr",
254 location_symbol != nullptr ? location_symbol->as_C_string() : "nullptr",
255 pkg_list->length());
256
257 // packages defined to java.base
258 if (log_is_enabled(Trace, module)) {
259 for (int x = 0; x < pkg_list->length(); x++) {
260 log_trace(module)("define_javabase_module(): creation of package %s for module " JAVA_BASE_NAME,
261 (pkg_list->at(x))->as_C_string());
262 }
263 }
264 }
265
266 // Caller needs ResourceMark.
267 static void throw_dup_pkg_exception(const char* module_name, PackageEntry* package, TRAPS) {
268 const char* package_name = package->name()->as_C_string();
269 if (package->module()->is_named()) {
270 THROW_MSG(vmSymbols::java_lang_IllegalStateException(),
271 err_msg("Package %s for module %s is already in another module, %s, defined to the class loader",
272 package_name, module_name, package->module()->name()->as_C_string()));
273 } else {
274 THROW_MSG(vmSymbols::java_lang_IllegalStateException(),
275 err_msg("Package %s for module %s is already in the unnamed module defined to the class loader",
276 package_name, module_name));
277 }
278 }
279
280 void Modules::define_module(Handle module, jboolean is_open, jstring version,
281 jstring location, jobjectArray packages, TRAPS) {
282 check_cds_restrictions(CHECK);
283 ResourceMark rm(THREAD);
284
285 if (module.is_null()) {
286 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null module object");
287 }
288
289 if (!java_lang_Module::is_instance(module())) {
290 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
291 "module is not an instance of type java.lang.Module");
292 }
293
294 int module_name_len;
295 char* module_name = get_module_name(module(), module_name_len, CHECK);
296 if (module_name == nullptr) {
297 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
298 "Module name cannot be null");
299 }
300
301 // Resolve packages
302 objArrayHandle packages_h(THREAD, objArrayOop(JNIHandles::resolve(packages)));
303 int num_packages = (packages_h.is_null() ? 0 : packages_h->length());
304
305 // Special handling of java.base definition
306 if (strcmp(module_name, JAVA_BASE_NAME) == 0) {
307 assert(is_open == JNI_FALSE, "java.base module cannot be open");
308 define_javabase_module(module, version, location, packages_h, num_packages, CHECK);
309 return;
310 }
311
312 oop loader = java_lang_Module::loader(module());
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 log_info(compilation)("EnableVectorSupport=%s", (EnableVectorSupport ? "true" : "false"));
471 log_info(compilation)("EnableVectorReboxing=%s", (EnableVectorReboxing ? "true" : "false"));
472 log_info(compilation)("EnableVectorAggressiveReboxing=%s", (EnableVectorAggressiveReboxing ? "true" : "false"));
473 }
474 #endif // COMPILER2_OR_JVMCI
475 }
476
477 #if INCLUDE_CDS_JAVA_HEAP
478 static bool _seen_platform_unnamed_module = false;
479 static bool _seen_system_unnamed_module = false;
480
481 // Validate the states of an java.lang.Module oop to be archived.
482 void Modules::check_archived_module_oop(oop orig_module_obj) {
483 assert(CDSConfig::is_dumping_full_module_graph(), "must be");
484 assert(java_lang_Module::is_instance(orig_module_obj), "must be");
485
486 ModuleEntry* orig_module_ent = java_lang_Module::module_entry_raw(orig_module_obj);
487 if (orig_module_ent == nullptr) {
488 // These special java.lang.Module oops are created in Java code. They are not
489 // defined via Modules::define_module(), so they don't have a ModuleEntry:
490 // java.lang.Module::ALL_UNNAMED_MODULE
491 // java.lang.Module::EVERYONE_MODULE
492 // jdk.internal.loader.ClassLoaders$BootClassLoader::unnamedModule
493 log_info(aot, module)("Archived java.lang.Module oop " PTR_FORMAT " with no ModuleEntry*", p2i(orig_module_obj));
494 assert(java_lang_Module::name(orig_module_obj) == nullptr, "must be unnamed");
495 } else {
496 // This java.lang.Module oop has an ModuleEntry*. Check if the latter is archived.
497 if (log_is_enabled(Info, aot, module)) {
498 ResourceMark rm;
499 LogStream ls(Log(aot, module)::info());
500 ls.print("Archived java.lang.Module oop " PTR_FORMAT " for ", p2i(orig_module_obj));
501 orig_module_ent->print(&ls);
502 }
503
504 // We only archive the default module graph, which should contain only java.lang.Module oops
505 // for the 3 built-in loaders (boot/platform/system)
506 ClassLoaderData* loader_data = orig_module_ent->loader_data();
507 assert(loader_data->is_builtin_class_loader_data(), "must be");
508
509 if (orig_module_ent->name() != nullptr) {
510 // For each named module, we archive both the java.lang.Module oop and the ModuleEntry.
511 assert(orig_module_ent->has_been_archived(), "sanity");
512 } else {
513 // We only archive two unnamed module oops (for platform and system loaders). These do NOT have an archived
514 // ModuleEntry.
515 //
516 // At runtime, these oops are fetched from java_lang_ClassLoader::unnamedModule(loader) and
517 // are initialized in ClassLoaderData::ClassLoaderData() => ModuleEntry::create_unnamed_module(), where
518 // a new ModuleEntry is allocated.
519 assert(!loader_data->is_boot_class_loader_data(), "unnamed module for boot loader should be not archived");
520 assert(!orig_module_ent->has_been_archived(), "sanity");
521
522 if (SystemDictionary::is_platform_class_loader(loader_data->class_loader())) {
523 assert(!_seen_platform_unnamed_module, "only once");
524 _seen_platform_unnamed_module = true;
525 } else if (SystemDictionary::is_system_class_loader(loader_data->class_loader())) {
526 assert(!_seen_system_unnamed_module, "only once");
527 _seen_system_unnamed_module = true;
528 } else {
529 // The java.lang.Module oop and ModuleEntry of the unnamed module of the boot loader are
530 // not in the archived module graph. These are always allocated at runtime.
531 ShouldNotReachHere();
532 }
533 }
534 }
535 }
536
537 void Modules::verify_archived_modules() {
538 ModuleEntry::verify_archived_module_entries();
539 }
540
541 class Modules::ArchivedProperty {
542 const char* _prop;
543 const bool _numbered;
544 const char* _archived_value;
545
546 const char* get_flattened_value() const {
547 if (_numbered) {
548 return get_numbered_property_as_sorted_string();
549 } else {
550 return Arguments::get_property(_prop);
551 }
552 }
553
554 void runtime_check() const;
555 const char* get_numbered_property_as_sorted_string() const;
556
557 public:
558 ArchivedProperty(const char* prop, bool numbered)
559 : _prop(prop), _numbered(numbered), _archived_value(nullptr) {}
560
561 void dump() {
562 ResourceMark rm;
563 const char* str = get_flattened_value();
564 if (str != nullptr) {
565 _archived_value = ArchiveBuilder::current()->ro_strdup(str);
566 }
567 }
568
569 void serialize(SerializeClosure* soc) {
570 soc->do_ptr(&_archived_value);
571 if (soc->reading()) {
572 runtime_check();
573 // Don't hold onto the pointer, in case we might decide to unmap the archive.
574 _archived_value = nullptr;
575 }
576 }
577 };
578
579 Modules::ArchivedProperty Modules::_archived_props[] = {
580 // non-numbered
581 {"jdk.module.main", false},
582
583 // numbered
584 {"jdk.module.addexports", true}, // --add-exports
585 {"jdk.module.addmods", true}, // --add-modules
586 {"jdk.module.enable.native.access", true}, // --enable-native-access
587 {"jdk.module.addopens", true}, // --add-opens
588 {"jdk.module.addreads", true}, // --add-reads
589 };
590
591 constexpr size_t Modules::num_archived_props() {
592 return sizeof(_archived_props) / sizeof(_archived_props[0]);
593 }
594
595 Modules::ArchivedProperty& Modules::archived_prop(size_t i) {
596 assert(i < num_archived_props(), "oob");
597 return _archived_props[i];
598 }
599
600 void Modules::ArchivedProperty::runtime_check() const {
601 ResourceMark rm;
602 const char* runtime_value = get_flattened_value();
603 aot_log_info(aot)("archived module property %s: %s", _prop,
604 _archived_value != nullptr ? _archived_value : "(null)");
605
606 bool disable = false;
607 if (runtime_value == nullptr) {
608 if (_archived_value != nullptr) {
609 MetaspaceShared::report_loading_error("Mismatched values for property %s: %s specified during dump time but not during runtime", _prop, _archived_value);
610 disable = true;
611 }
612 } else {
613 if (_archived_value == nullptr) {
614 MetaspaceShared::report_loading_error("Mismatched values for property %s: %s specified during runtime but not during dump time", _prop, runtime_value);
615 disable = true;
616 } else if (strcmp(runtime_value, _archived_value) != 0) {
617 MetaspaceShared::report_loading_error("Mismatched values for property %s: runtime %s dump time %s", _prop, runtime_value, _archived_value);
618 disable = true;
619 }
620 }
621
622 if (disable) {
623 MetaspaceShared::report_loading_error("Disabling optimized module handling");
624 CDSConfig::stop_using_optimized_module_handling();
625 }
626 }
627
628 // Caller needs ResourceMark
629 const char* Modules::ArchivedProperty::get_numbered_property_as_sorted_string() const {
630 assert(_numbered, "sanity");
631 // theoretical string size limit for decimal int, but the following loop will end much sooner due to
632 // OS command-line size limit.
633 const int max_digits = 10;
634 const int extra_symbols_count = 2; // includes '.', '\0'
635 size_t prop_len = strlen(_prop) + max_digits + extra_symbols_count;
636 char* prop_name = resource_allocate_bytes(prop_len);
637 GrowableArray<const char*> list;
638 for (unsigned int i = 0;; i++) {
639 jio_snprintf(prop_name, prop_len, "%s.%d", _prop, i);
640 const char* prop_value = Arguments::get_property(prop_name);
641 if (prop_value == nullptr) {
642 break;
643 }
644 char* p = ResourceArea::strdup(prop_value);
645 while (*p == ',') p++; // skip leading commas
646 while (*p) {
647 char* next = strchr(p, ',');
648 if (next == nullptr) {
649 // no more commas, p is the last element
650 list.append(p);
651 break;
652 } else {
653 *next = 0;
654 list.append(p);
655 p = next + 1;
656 }
657 }
658 }
659
660 // Example:
661 // --add-modules=java.compiler --add-modules=java.base,java.base,,
662 //
663 // list[0] = "java.compiler"
664 // list[1] = "java.base"
665 // list[2] = "java.base"
666 // list[3] = ""
667 // list[4] = ""
668 list.sort(ClassLoaderExt::compare_module_names);
669
670 const char* prefix = "";
671 stringStream st;
672 const char* last_string = ""; // This also filters out all empty strings
673 for (int i = 0; i < list.length(); i++) {
674 const char* m = list.at(i);
675 if (strcmp(m, last_string) != 0) { // filter out duplicates
676 st.print("%s%s", prefix, m);
677 last_string = m;
678 prefix = ",";
679 }
680 }
681
682 return (st.size() > 0) ? st.as_string() : nullptr; // Example: "java.base,java.compiler"
683 }
684
685 void Modules::dump_archived_module_info() {
686 for (size_t i = 0; i < num_archived_props(); i++) {
687 archived_prop(i).dump();
688 }
689 }
690
691 void Modules::serialize_archived_module_info(SerializeClosure* soc) {
692 for (size_t i = 0; i < num_archived_props(); i++) {
693 archived_prop(i).serialize(soc);
694 }
695 if (soc->reading()) {
696 aot_log_info(aot)("optimized module handling: %s", CDSConfig::is_using_optimized_module_handling() ? "enabled" : "disabled");
697 aot_log_info(aot)("full module graph: %s", CDSConfig::is_using_full_module_graph() ? "enabled" : "disabled");
698 }
699 }
700
701 void Modules::define_archived_modules(Handle h_platform_loader, Handle h_system_loader, TRAPS) {
702 assert(CDSConfig::is_using_full_module_graph(), "must be");
703
704 // We don't want the classes used by the archived full module graph to be redefined by JVMTI.
705 // Luckily, such classes are loaded in the JVMTI "early" phase, and CDS is disabled if a JVMTI
706 // agent wants to redefine classes in this phase.
707 JVMTI_ONLY(assert(JvmtiExport::is_early_phase(), "must be"));
708 assert(!(JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()),
709 "CDS should be disabled if early class hooks are enabled");
710
711 Handle java_base_module(THREAD, ClassLoaderDataShared::restore_archived_oops_for_null_class_loader_data());
712 // Patch any previously loaded class's module field with java.base's java.lang.Module.
713 ModuleEntryTable::patch_javabase_entries(THREAD, java_base_module);
714
715 if (h_platform_loader.is_null()) {
716 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null platform loader object");
717 }
718
719 if (h_system_loader.is_null()) {
720 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null system loader object");
721 }
722
723 ClassLoaderData* platform_loader_data = SystemDictionary::register_loader(h_platform_loader);
724 SystemDictionary::set_platform_loader(platform_loader_data);
725 ClassLoaderDataShared::restore_java_platform_loader_from_archive(platform_loader_data);
726
727 ClassLoaderData* system_loader_data = SystemDictionary::register_loader(h_system_loader);
728 SystemDictionary::set_system_loader(system_loader_data);
729 // system_loader_data here is always an instance of jdk.internal.loader.ClassLoader$AppClassLoader.
730 // However, if -Djava.system.class.loader=xxx is specified, java_platform_loader() would
731 // be an instance of a user-defined class, so make sure this never happens.
732 assert(Arguments::get_property("java.system.class.loader") == nullptr,
733 "archived full module should have been disabled if -Djava.system.class.loader is specified");
734 ClassLoaderDataShared::restore_java_system_loader_from_archive(system_loader_data);
735 }
736
737 void Modules::check_cds_restrictions(TRAPS) {
738 if (CDSConfig::is_dumping_full_module_graph() && Universe::is_module_initialized()) {
739 THROW_MSG(vmSymbols::java_lang_UnsupportedOperationException(),
740 "During -Xshare:dump, module system cannot be modified after it's initialized");
741 }
742 }
743 #endif // INCLUDE_CDS_JAVA_HEAP
744
745 void Modules::set_bootloader_unnamed_module(Handle module, TRAPS) {
746 ResourceMark rm(THREAD);
747
748 if (module.is_null()) {
749 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null module object");
750 }
751 if (!java_lang_Module::is_instance(module())) {
752 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
753 "module is not an instance of type java.lang.Module");
754 }
755
756 // Ensure that this is an unnamed module
757 oop name = java_lang_Module::name(module());
758 if (name != nullptr) {
759 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
760 "boot loader's unnamed module's java.lang.Module has a name");
761 }
762
763 // Validate java_base's loader is the boot loader.
764 oop loader = java_lang_Module::loader(module());
765 if (loader != nullptr) {
766 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
767 "Class loader must be the boot class loader");
768 }
769
770 log_debug(module)("set_bootloader_unnamed_module(): recording unnamed module for boot loader");
771
772 // Set java.lang.Module for the boot loader's unnamed module
773 ClassLoaderData* boot_loader_data = ClassLoaderData::the_null_class_loader_data();
774 ModuleEntry* unnamed_module = boot_loader_data->unnamed_module();
775 assert(unnamed_module != nullptr, "boot loader's unnamed ModuleEntry not defined");
776 unnamed_module->set_module(boot_loader_data->add_handle(module));
777 // Store pointer to the ModuleEntry in the unnamed module's java.lang.Module object.
778 java_lang_Module::set_module_entry(module(), unnamed_module);
779 }
780
781 void Modules::add_module_exports(Handle from_module, jstring package_name, Handle to_module, TRAPS) {
782 check_cds_restrictions(CHECK);
783
784 if (package_name == nullptr) {
785 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
786 "package is null");
787 }
788 if (from_module.is_null()) {
789 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
790 "from_module is null");
791 }
792 ModuleEntry* from_module_entry = get_module_entry(from_module, CHECK);
793 if (from_module_entry == nullptr) {
794 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
795 "from_module cannot be found");
796 }
797
798 // All packages in unnamed and open modules are exported by default.
799 if (!from_module_entry->is_named() || from_module_entry->is_open()) return;
800
801 ModuleEntry* to_module_entry;
802 if (to_module.is_null()) {
803 to_module_entry = nullptr; // It's an unqualified export.
804 } else {
805 to_module_entry = get_module_entry(to_module, CHECK);
806 if (to_module_entry == nullptr) {
807 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
808 "to_module is invalid");
809 }
810 }
811
812 PackageEntry* package_entry = nullptr;
813 char buf[128];
814 int package_len;
815
816 ResourceMark rm(THREAD);
817 const char* pkg = as_internal_package(JNIHandles::resolve_non_null(package_name), buf, sizeof(buf), package_len);
818 {
819 MutexLocker ml(THREAD, Module_lock);
820 package_entry = get_locked_package_entry(from_module_entry, pkg, package_len);
821 // Do nothing if modules are the same
822 // If the package is not found we'll throw an exception later
823 if (from_module_entry != to_module_entry &&
824 package_entry != nullptr) {
825 package_entry->set_exported(to_module_entry);
826 }
827 }
828
829 // Handle errors and logging outside locked section
830 if (package_entry == nullptr) {
831 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
832 err_msg("Package %s not found in from_module %s",
833 pkg != nullptr ? pkg : "",
834 from_module_entry->name()->as_C_string()));
835 }
836
837 if (log_is_enabled(Debug, module)) {
838 log_debug(module)("add_module_exports(): package %s in module %s is exported to module %s",
839 package_entry->name()->as_C_string(),
840 from_module_entry->name()->as_C_string(),
841 to_module_entry == nullptr ? "null" :
842 to_module_entry->is_named() ?
843 to_module_entry->name()->as_C_string() : UNNAMED_MODULE);
844 }
845 }
846
847
848 void Modules::add_module_exports_qualified(Handle from_module, jstring package,
849 Handle to_module, TRAPS) {
850 check_cds_restrictions(CHECK);
851 if (to_module.is_null()) {
852 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
853 "to_module is null");
854 }
855 add_module_exports(from_module, package, to_module, CHECK);
856 }
857
858 void Modules::add_reads_module(Handle from_module, Handle to_module, TRAPS) {
859 check_cds_restrictions(CHECK);
860 if (from_module.is_null()) {
861 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
862 "from_module is null");
863 }
864
865 ModuleEntry* from_module_entry = get_module_entry(from_module, CHECK);
866 if (from_module_entry == nullptr) {
867 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
868 "from_module is not valid");
869 }
870
871 ModuleEntry* to_module_entry;
872 if (!to_module.is_null()) {
873 to_module_entry = get_module_entry(to_module, CHECK);
874 if (to_module_entry == nullptr) {
875 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
876 "to_module is invalid");
877 }
878 } else {
879 to_module_entry = nullptr;
880 }
881
882 ResourceMark rm(THREAD);
883 log_debug(module)("add_reads_module(): Adding read from module %s to module %s",
884 from_module_entry->is_named() ?
885 from_module_entry->name()->as_C_string() : UNNAMED_MODULE,
886 to_module_entry == nullptr ? "all unnamed" :
887 (to_module_entry->is_named() ?
888 to_module_entry->name()->as_C_string() : UNNAMED_MODULE));
889
890 // if modules are the same or if from_module is unnamed then no need to add the read.
891 if (from_module_entry != to_module_entry && from_module_entry->is_named()) {
892 from_module_entry->add_read(to_module_entry);
893 }
894 }
895
896 // This method is called by JFR and JNI.
897 jobject Modules::get_module(jclass clazz, TRAPS) {
898 assert(ModuleEntryTable::javabase_defined(),
899 "Attempt to call get_module before " JAVA_BASE_NAME " is defined");
900
901 if (clazz == nullptr) {
902 THROW_MSG_(vmSymbols::java_lang_NullPointerException(),
903 "class is null", nullptr);
904 }
905 oop mirror = JNIHandles::resolve_non_null(clazz);
906 if (mirror == nullptr) {
907 log_debug(module)("get_module(): no mirror, returning nullptr");
908 return nullptr;
909 }
910 if (!java_lang_Class::is_instance(mirror)) {
911 THROW_MSG_(vmSymbols::java_lang_IllegalArgumentException(),
912 "Invalid class", nullptr);
913 }
914
915 oop module = java_lang_Class::module(mirror);
916
917 assert(module != nullptr, "java.lang.Class module field not set");
918 assert(java_lang_Module::is_instance(module), "module is not an instance of type java.lang.Module");
919
920 LogTarget(Debug,module) lt;
921 if (lt.is_enabled()) {
922 LogStream ls(lt);
923 Klass* klass = java_lang_Class::as_Klass(mirror);
924 oop module_name = java_lang_Module::name(module);
925 if (module_name != nullptr) {
926 ls.print("get_module(): module ");
927 java_lang_String::print(module_name, tty);
928 } else {
929 ls.print("get_module(): Unnamed Module");
930 }
931 if (klass != nullptr) {
932 ResourceMark rm(THREAD);
933 ls.print_cr(" for class %s", klass->external_name());
934 } else {
935 ls.print_cr(" for primitive class");
936 }
937 }
938
939 return JNIHandles::make_local(THREAD, module);
940 }
941
942 oop Modules::get_named_module(Handle h_loader, const char* package_name) {
943 assert(ModuleEntryTable::javabase_defined(),
944 "Attempt to call get_named_module before " JAVA_BASE_NAME " is defined");
945 assert(h_loader.is_null() || java_lang_ClassLoader::is_subclass(h_loader->klass()),
946 "Class loader is not a subclass of java.lang.ClassLoader");
947 assert(package_name != nullptr, "the package_name should not be null");
948
949 if (strlen(package_name) == 0) {
950 return nullptr;
951 }
952 TempNewSymbol package_sym = SymbolTable::new_symbol(package_name);
953 const PackageEntry* const pkg_entry =
954 get_package_entry_by_name(package_sym, h_loader);
955 const ModuleEntry* const module_entry = (pkg_entry != nullptr ? pkg_entry->module() : nullptr);
956
957 if (module_entry != nullptr && module_entry->module() != nullptr && module_entry->is_named()) {
958 return module_entry->module();
959 }
960 return nullptr;
961 }
962
963 // Export package in module to all unnamed modules.
964 void Modules::add_module_exports_to_all_unnamed(Handle module, jstring package_name, TRAPS) {
965 check_cds_restrictions(CHECK);
966 if (module.is_null()) {
967 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
968 "module is null");
969 }
970 if (package_name == nullptr) {
971 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
972 "package is null");
973 }
974 ModuleEntry* module_entry = get_module_entry(module, CHECK);
975 if (module_entry == nullptr) {
976 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
977 "module is invalid");
978 }
979
980 // No-op for unnamed module and open modules
981 if (!module_entry->is_named() || module_entry->is_open())
982 return;
983
984 ResourceMark rm(THREAD);
985 char buf[128];
986 int pkg_len;
987 const char* pkg = as_internal_package(JNIHandles::resolve_non_null(package_name), buf, sizeof(buf), pkg_len);
988 PackageEntry* package_entry = nullptr;
989 {
990 MutexLocker m1(THREAD, Module_lock);
991 package_entry = get_locked_package_entry(module_entry, pkg, pkg_len);
992
993 // Mark package as exported to all unnamed modules.
994 if (package_entry != nullptr) {
995 package_entry->set_is_exported_allUnnamed();
996 }
997 }
998
999 // Handle errors and logging outside locked section
1000 if (package_entry == nullptr) {
1001 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
1002 err_msg("Package %s not found in module %s",
1003 pkg != nullptr ? pkg : "",
1004 module_entry->name()->as_C_string()));
1005 }
1006
1007 if (log_is_enabled(Debug, module)) {
1008 log_debug(module)("add_module_exports_to_all_unnamed(): package %s in module"
1009 " %s is exported to all unnamed modules",
1010 package_entry->name()->as_C_string(),
1011 module_entry->name()->as_C_string());
1012 }
1013 }