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/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 ResourceMark rm(THREAD);
283
284 if (module.is_null()) {
285 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null module object");
286 }
287
288 if (!java_lang_Module::is_instance(module())) {
289 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
290 "module is not an instance of type java.lang.Module");
291 }
292
293 int module_name_len;
294 char* module_name = get_module_name(module(), module_name_len, CHECK);
295 if (module_name == nullptr) {
296 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
297 "Module name cannot be null");
298 }
299
300 // Resolve packages
301 objArrayHandle packages_h(THREAD, objArrayOop(JNIHandles::resolve(packages)));
302 int num_packages = (packages_h.is_null() ? 0 : packages_h->length());
303 if (strncmp(module_name, "jdk.proxy", 9) != 0) {
304 check_cds_restrictions(Handle(), Handle(), CHECK);
305 }
306
307 // Special handling of java.base definition
308 if (strcmp(module_name, JAVA_BASE_NAME) == 0) {
309 assert(is_open == JNI_FALSE, "java.base module cannot be open");
310 define_javabase_module(module, version, location, packages_h, num_packages, CHECK);
311 return;
312 }
313
314 oop loader = java_lang_Module::loader(module());
315 Handle h_loader = Handle(THREAD, loader);
316 // define_module can be called during start-up, before the class loader's ClassLoaderData
317 // has been created. SystemDictionary::register_loader ensures creation, if needed.
318 ClassLoaderData* loader_data = SystemDictionary::register_loader(h_loader);
319 assert(loader_data != nullptr, "class loader data shouldn't be null");
320
321 // Only modules defined to either the boot or platform class loader, can define a "java/" package.
322 bool java_pkg_disallowed = !h_loader.is_null() &&
323 !SystemDictionary::is_platform_class_loader(h_loader());
324
325 // Check that the list of packages has no duplicates and that the
326 // packages are syntactically ok.
327 char buf[128];
328 GrowableArray<Symbol*>* pkg_list = new GrowableArray<Symbol*>(num_packages);
329 for (int x = 0; x < num_packages; x++) {
330 oop pkg_str = packages_h->obj_at(x);
331 if (pkg_str == nullptr || pkg_str->klass() != vmClasses::String_klass()) {
332 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
333 err_msg("Bad package name"));
334 }
335
336 int package_len;
337 const char* package_name = as_internal_package(pkg_str, buf, sizeof(buf), package_len);
338 if (!verify_package_name(package_name, package_len)) {
339 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
340 err_msg("Invalid package name: %s for module: %s",
341 package_name, module_name));
342 }
343
344 // Only modules defined to either the boot or platform class loader, can define a "java/" package.
345 if (java_pkg_disallowed &&
346 (strncmp(package_name, JAVAPKG, JAVAPKG_LEN) == 0 &&
347 (package_name[JAVAPKG_LEN] == JVM_SIGNATURE_SLASH || package_name[JAVAPKG_LEN] == '\0'))) {
348 const char* class_loader_name = loader_data->loader_name_and_id();
349 size_t pkg_len = strlen(package_name);
350 char* pkg_name = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, pkg_len + 1);
351 strncpy(pkg_name, package_name, pkg_len + 1);
352 StringUtils::replace_no_expand(pkg_name, "/", ".");
353 const char* msg_text1 = "Class loader (instance of): ";
354 const char* msg_text2 = " tried to define prohibited package name: ";
355 size_t len = strlen(msg_text1) + strlen(class_loader_name) + strlen(msg_text2) + pkg_len + 1;
356 char* message = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, len);
357 jio_snprintf(message, len, "%s%s%s%s", msg_text1, class_loader_name, msg_text2, pkg_name);
358 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), message);
359 }
360
361 Symbol* pkg_symbol = SymbolTable::new_symbol(package_name, package_len);
362 pkg_list->append(pkg_symbol);
363 }
364
365 ModuleEntryTable* module_table = get_module_entry_table(h_loader);
366 assert(module_table != nullptr, "module entry table shouldn't be null");
367
368 // Create symbol* entry for module name.
369 TempNewSymbol module_symbol = SymbolTable::new_symbol(module_name, module_name_len);
370
371 bool dupl_modules = false;
372
373 // Create symbol for module version.
374 TempNewSymbol version_symbol = as_symbol(version);
375
376 // Create symbol* entry for module location.
377 TempNewSymbol location_symbol = as_symbol(location);
378
379 PackageEntryTable* package_table = nullptr;
380 PackageEntry* existing_pkg = nullptr;
381 {
382 MutexLocker ml(THREAD, Module_lock);
383
384 if (num_packages > 0) {
385 package_table = get_package_entry_table(h_loader);
386 assert(package_table != nullptr, "Missing package_table");
387
388 // Check that none of the packages exist in the class loader's package table.
389 for (int x = 0; x < pkg_list->length(); x++) {
390 existing_pkg = package_table->locked_lookup_only(pkg_list->at(x));
391 if (existing_pkg != nullptr) {
392 // This could be because the module was already defined. If so,
393 // report that error instead of the package error.
394 if (module_table->lookup_only(module_symbol) != nullptr) {
395 dupl_modules = true;
396 }
397 break;
398 }
399 }
400 } // if (num_packages > 0)...
401
402 // Add the module and its packages.
403 if (!dupl_modules && existing_pkg == nullptr) {
404 if (module_table->lookup_only(module_symbol) == nullptr) {
405 // Create the entry for this module in the class loader's module entry table.
406 ModuleEntry* module_entry = module_table->locked_create_entry(module,
407 (is_open == JNI_TRUE), module_symbol,
408 version_symbol, location_symbol, loader_data);
409 assert(module_entry != nullptr, "module_entry creation failed");
410
411 // Add the packages.
412 assert(pkg_list->length() == 0 || package_table != nullptr, "Bad package table");
413 for (int y = 0; y < pkg_list->length(); y++) {
414 package_table->locked_create_entry(pkg_list->at(y), module_entry);
415
416 // Unable to have a GrowableArray of TempNewSymbol. Must decrement the refcount of
417 // the Symbol* that was created above for each package. The refcount was incremented
418 // by SymbolTable::new_symbol and as well by the PackageEntry creation.
419 pkg_list->at(y)->decrement_refcount();
420 }
421
422 // Store pointer to ModuleEntry record in java.lang.Module object.
423 java_lang_Module::set_module_entry(module(), module_entry);
424 } else {
425 dupl_modules = true;
426 }
427 }
428 } // Release the lock
429
430 // any errors ?
431 if (dupl_modules) {
432 THROW_MSG(vmSymbols::java_lang_IllegalStateException(),
433 err_msg("Module %s is already defined", module_name));
434 } else if (existing_pkg != nullptr) {
435 throw_dup_pkg_exception(module_name, existing_pkg, CHECK);
436 }
437
438 log_info(module, load)("%s location: %s", module_name,
439 location_symbol != nullptr ? location_symbol->as_C_string() : "null");
440 LogTarget(Debug, module) lt;
441 if (lt.is_enabled()) {
442 LogStream ls(lt);
443 ls.print("define_module(): creation of module: %s, version: %s, location: %s, ",
444 module_name, version_symbol != nullptr ? version_symbol->as_C_string() : "null",
445 location_symbol != nullptr ? location_symbol->as_C_string() : "null");
446 loader_data->print_value_on(&ls);
447 ls.print_cr(", package #: %d", pkg_list->length());
448 for (int y = 0; y < pkg_list->length(); y++) {
449 log_trace(module)("define_module(): creation of package %s for module %s",
450 (pkg_list->at(y))->as_C_string(), module_name);
451 }
452 }
453
454 // If the module is defined to the boot loader and an exploded build is being
455 // used, prepend <java.home>/modules/modules_name to the boot class path.
456 if (h_loader.is_null() && !ClassLoader::has_jrt_entry()) {
457 ClassLoader::add_to_exploded_build_list(THREAD, module_symbol);
458 }
459
460 #if COMPILER2_OR_JVMCI
461 // Special handling of jdk.incubator.vector
462 if (strcmp(module_name, "jdk.incubator.vector") == 0) {
463 if (FLAG_IS_DEFAULT(EnableVectorSupport)) {
464 FLAG_SET_DEFAULT(EnableVectorSupport, true);
465 }
466 if (EnableVectorSupport && FLAG_IS_DEFAULT(EnableVectorReboxing)) {
467 FLAG_SET_DEFAULT(EnableVectorReboxing, true);
468 }
469 if (EnableVectorSupport && EnableVectorReboxing && FLAG_IS_DEFAULT(EnableVectorAggressiveReboxing)) {
470 FLAG_SET_DEFAULT(EnableVectorAggressiveReboxing, true);
471 }
472 if (EnableVectorSupport && FLAG_IS_DEFAULT(UseVectorStubs)) {
473 FLAG_SET_DEFAULT(UseVectorStubs, true);
474 }
475 log_info(compilation)("EnableVectorSupport=%s", (EnableVectorSupport ? "true" : "false"));
476 log_info(compilation)("EnableVectorReboxing=%s", (EnableVectorReboxing ? "true" : "false"));
477 log_info(compilation)("EnableVectorAggressiveReboxing=%s", (EnableVectorAggressiveReboxing ? "true" : "false"));
478 log_info(compilation)("UseVectorStubs=%s", (UseVectorStubs ? "true" : "false"));
479 }
480 #endif // COMPILER2_OR_JVMCI
481 }
482
483 #if INCLUDE_CDS_JAVA_HEAP
484 static bool _seen_platform_unnamed_module = false;
485 static bool _seen_system_unnamed_module = false;
486
487 // Validate the states of an java.lang.Module oop to be archived.
488 //
489 // Returns true iff the oop has an archived ModuleEntry.
490 bool Modules::check_archived_module_oop(oop orig_module_obj) {
491 assert(CDSConfig::is_dumping_full_module_graph(), "must be");
492 assert(java_lang_Module::is_instance(orig_module_obj), "must be");
493
494 ModuleEntry* orig_module_ent = java_lang_Module::module_entry_raw(orig_module_obj);
495 if (orig_module_ent == nullptr) {
496 // These special java.lang.Module oops are created in Java code. They are not
497 // defined via Modules::define_module(), so they don't have a ModuleEntry:
498 // java.lang.Module::ALL_UNNAMED_MODULE
499 // java.lang.Module::EVERYONE_MODULE
500 // jdk.internal.loader.ClassLoaders$BootClassLoader::unnamedModule
501 log_info(cds, module)("Archived java.lang.Module oop " PTR_FORMAT " with no ModuleEntry*", p2i(orig_module_obj));
502 assert(java_lang_Module::name(orig_module_obj) == nullptr, "must be unnamed");
503 return false;
504 } else {
505 // This java.lang.Module oop has an ModuleEntry*. Check if the latter is archived.
506 if (log_is_enabled(Info, cds, module)) {
507 ResourceMark rm;
508 LogStream ls(Log(cds, module)::info());
509 ls.print("Archived java.lang.Module oop " PTR_FORMAT " for ", p2i(orig_module_obj));
510 orig_module_ent->print(&ls);
511 }
512
513 // We only archive the default module graph, which should contain only java.lang.Module oops
514 // for the 3 built-in loaders (boot/platform/system)
515 ClassLoaderData* loader_data = orig_module_ent->loader_data();
516 assert(loader_data->is_builtin_class_loader_data(), "must be");
517
518 if (orig_module_ent->name() != nullptr) {
519 // For each named module, we archive both the java.lang.Module oop and the ModuleEntry.
520 assert(orig_module_ent->has_been_archived(), "sanity");
521 return true;
522 } else {
523 // We only archive two unnamed module oops (for platform and system loaders). These do NOT have an archived
524 // ModuleEntry.
525 //
526 // At runtime, these oops are fetched from java_lang_ClassLoader::unnamedModule(loader) and
527 // are initialized in ClassLoaderData::ClassLoaderData() => ModuleEntry::create_unnamed_module(), where
528 // a new ModuleEntry is allocated.
529 assert(!loader_data->is_boot_class_loader_data(), "unnamed module for boot loader should be not archived");
530 assert(!orig_module_ent->has_been_archived(), "sanity");
531
532 if (SystemDictionary::is_platform_class_loader(loader_data->class_loader())) {
533 assert(!_seen_platform_unnamed_module, "only once");
534 _seen_platform_unnamed_module = true;
535 } else if (SystemDictionary::is_system_class_loader(loader_data->class_loader())) {
536 assert(!_seen_system_unnamed_module, "only once");
537 _seen_system_unnamed_module = true;
538 } else {
539 // The java.lang.Module oop and ModuleEntry of the unnamed module of the boot loader are
540 // not in the archived module graph. These are always allocated at runtime.
541 ShouldNotReachHere();
542 }
543 return false;
544 }
545 }
546 }
547
548 void Modules::update_oops_in_archived_module(oop orig_module_obj, int archived_module_root_index) {
549 // This java.lang.Module oop must have an archived ModuleEntry
550 assert(check_archived_module_oop(orig_module_obj) == true, "sanity");
551
552 // We remember the oop inside the ModuleEntry::_archived_module_index. At runtime, we use
553 // this index to reinitialize the ModuleEntry inside ModuleEntry::restore_archived_oops().
554 //
555 // ModuleEntry::verify_archived_module_entries(), called below, ensures that every archived
556 // ModuleEntry has been assigned an _archived_module_index.
557 ModuleEntry* orig_module_ent = java_lang_Module::module_entry_raw(orig_module_obj);
558 ModuleEntry::get_archived_entry(orig_module_ent)->update_oops_in_archived_module(archived_module_root_index);
559 }
560
561 void Modules::verify_archived_modules() {
562 ModuleEntry::verify_archived_module_entries();
563 }
564
565 char* Modules::_archived_main_module_name = nullptr;
566 char* Modules::_archived_addmods_names = nullptr;
567 char* Modules::_archived_native_access_flags = nullptr;
568
569 void Modules::dump_main_module_name() {
570 const char* module_name = Arguments::get_property("jdk.module.main");
571 if (module_name != nullptr) {
572 _archived_main_module_name = ArchiveBuilder::current()->ro_strdup(module_name);
573 }
574 }
575
576 void Modules::check_archived_flag_consistency(char* archived_flag, const char* runtime_flag, const char* property) {
577 log_info(cds)("%s %s", property,
578 archived_flag != nullptr ? archived_flag : "(null)");
579 bool disable = false;
580 if (runtime_flag == nullptr) {
581 if (archived_flag != nullptr) {
582 log_info(cds)("Mismatched values for property %s: %s specified during dump time but not during runtime", property, archived_flag);
583 disable = true;
584 }
585 } else {
586 if (archived_flag == nullptr) {
587 log_info(cds)("Mismatched values for property %s: %s specified during runtime but not during dump time", property, runtime_flag);
588 disable = true;
589 } else if (strcmp(runtime_flag, archived_flag) != 0) {
590 log_info(cds)("Mismatched values for property %s: runtime %s dump time %s", property, runtime_flag, archived_flag);
591 disable = true;
592 }
593 }
594
595 if (disable) {
596 log_info(cds)("Disabling optimized module handling");
597 CDSConfig::stop_using_optimized_module_handling();
598 }
599 log_info(cds)("optimized module handling: %s", CDSConfig::is_using_optimized_module_handling() ? "enabled" : "disabled");
600 log_info(cds)("full module graph: %s", CDSConfig::is_using_full_module_graph() ? "enabled" : "disabled");
601 }
602
603 void Modules::dump_archived_module_info() {
604 // Write module name into archive
605 CDS_JAVA_HEAP_ONLY(Modules::dump_main_module_name();)
606 // Write module names from --add-modules into archive
607 CDS_JAVA_HEAP_ONLY(Modules::dump_addmods_names();)
608 // Write native enable-native-access flag into archive
609 CDS_JAVA_HEAP_ONLY(Modules::dump_native_access_flag());
610 }
611
612 void Modules::serialize_archived_module_info(SerializeClosure* soc) {
613 CDS_JAVA_HEAP_ONLY(Modules::serialize(soc);)
614 CDS_JAVA_HEAP_ONLY(Modules::serialize_addmods_names(soc);)
615 CDS_JAVA_HEAP_ONLY(Modules::serialize_native_access_flags(soc);)
616 }
617
618 void Modules::serialize(SerializeClosure* soc) {
619 soc->do_ptr(&_archived_main_module_name);
620 if (soc->reading()) {
621 const char* runtime_main_module = Arguments::get_property("jdk.module.main");
622 log_info(cds)("_archived_main_module_name %s",
623 _archived_main_module_name != nullptr ? _archived_main_module_name : "(null)");
624
625 check_archived_flag_consistency(_archived_main_module_name, runtime_main_module, "jdk.module.main");
626
627 // Don't hold onto the pointer, in case we might decide to unmap the archive.
628 _archived_main_module_name = nullptr;
629 }
630 }
631
632 void Modules::dump_native_access_flag() {
633 const char* native_access_names = get_native_access_flags_as_sorted_string();
634 if (native_access_names != nullptr) {
635 _archived_native_access_flags = ArchiveBuilder::current()->ro_strdup(native_access_names);
636 }
637 }
638
639 const char* Modules::get_native_access_flags_as_sorted_string() {
640 return get_numbered_property_as_sorted_string("jdk.module.enable.native.access");
641 }
642
643 void Modules::serialize_native_access_flags(SerializeClosure* soc) {
644 soc->do_ptr(&_archived_native_access_flags);
645 if (soc->reading()) {
646 check_archived_flag_consistency(_archived_native_access_flags, get_native_access_flags_as_sorted_string(), "jdk.module.enable.native.access");
647
648 // Don't hold onto the pointer, in case we might decide to unmap the archive.
649 _archived_native_access_flags = nullptr;
650 }
651 }
652
653 void Modules::dump_addmods_names() {
654 const char* addmods_names = get_addmods_names_as_sorted_string();
655 if (addmods_names != nullptr) {
656 _archived_addmods_names = ArchiveBuilder::current()->ro_strdup(addmods_names);
657 }
658 }
659
660 const char* Modules::get_addmods_names_as_sorted_string() {
661 return get_numbered_property_as_sorted_string("jdk.module.addmods");
662 }
663
664 void Modules::serialize_addmods_names(SerializeClosure* soc) {
665 soc->do_ptr(&_archived_addmods_names);
666 if (soc->reading()) {
667 check_archived_flag_consistency(_archived_addmods_names, get_addmods_names_as_sorted_string(), "jdk.module.addmods");
668
669 // Don't hold onto the pointer, in case we might decide to unmap the archive.
670 _archived_addmods_names = nullptr;
671 }
672 }
673
674 const char* Modules::get_numbered_property_as_sorted_string(const char* property) {
675 ResourceMark rm;
676 // theoretical string size limit for decimal int, but the following loop will end much sooner due to
677 // OS command-line size limit.
678 const int max_digits = 10;
679 const int extra_symbols_count = 2; // includes '.', '\0'
680 size_t prop_len = strlen(property) + max_digits + extra_symbols_count;
681 char* prop_name = resource_allocate_bytes(prop_len);
682 GrowableArray<const char*> list;
683 for (unsigned int i = 0;; i++) {
684 jio_snprintf(prop_name, prop_len, "%s.%d", property, i);
685 const char* prop_value = Arguments::get_property(prop_name);
686 if (prop_value == nullptr) {
687 break;
688 }
689 char* p = resource_allocate_bytes(strlen(prop_value) + 1);
690 strcpy(p, prop_value);
691 while (*p == ',') p++; // skip leading commas
692 while (*p) {
693 char* next = strchr(p, ',');
694 if (next == nullptr) {
695 // no more commas, p is the last element
696 list.append(p);
697 break;
698 } else {
699 *next = 0;
700 list.append(p);
701 p = next + 1;
702 }
703 }
704 }
705
706 // Example:
707 // --add-modules=java.compiler --add-modules=java.base,java.base,,
708 //
709 // list[0] = "java.compiler"
710 // list[1] = "java.base"
711 // list[2] = "java.base"
712 // list[3] = ""
713 // list[4] = ""
714 list.sort(ClassLoaderExt::compare_module_names);
715
716 const char* prefix = "";
717 stringStream st;
718 const char* last_string = ""; // This also filters out all empty strings
719 for (int i = 0; i < list.length(); i++) {
720 const char* m = list.at(i);
721 if (strcmp(m, last_string) != 0) { // filter out duplicates
722 st.print("%s%s", prefix, m);
723 last_string = m;
724 prefix = ",";
725 }
726 }
727
728 return (st.size() > 0) ? os::strdup(st.as_string()) : nullptr; // Example: "java.base,java.compiler"
729 }
730
731 void Modules::define_archived_modules(Handle h_platform_loader, Handle h_system_loader, TRAPS) {
732 assert(CDSConfig::is_using_full_module_graph(), "must be");
733
734 // We don't want the classes used by the archived full module graph to be redefined by JVMTI.
735 // Luckily, such classes are loaded in the JVMTI "early" phase, and CDS is disabled if a JVMTI
736 // agent wants to redefine classes in this phase.
737 JVMTI_ONLY(assert(JvmtiExport::is_early_phase(), "must be"));
738 assert(!(JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()),
739 "CDS should be disabled if early class hooks are enabled");
740
741 Handle java_base_module(THREAD, ClassLoaderDataShared::restore_archived_oops_for_null_class_loader_data());
742 // Patch any previously loaded class's module field with java.base's java.lang.Module.
743 ModuleEntryTable::patch_javabase_entries(THREAD, java_base_module);
744
745 if (h_platform_loader.is_null()) {
746 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null platform loader object");
747 }
748
749 if (h_system_loader.is_null()) {
750 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null system loader object");
751 }
752
753 ClassLoaderData* platform_loader_data = SystemDictionary::register_loader(h_platform_loader);
754 SystemDictionary::set_platform_loader(platform_loader_data);
755 ClassLoaderDataShared::restore_java_platform_loader_from_archive(platform_loader_data);
756
757 ClassLoaderData* system_loader_data = SystemDictionary::register_loader(h_system_loader);
758 SystemDictionary::set_system_loader(system_loader_data);
759 // system_loader_data here is always an instance of jdk.internal.loader.ClassLoader$AppClassLoader.
760 // However, if -Djava.system.class.loader=xxx is specified, java_platform_loader() would
761 // be an instance of a user-defined class, so make sure this never happens.
762 assert(Arguments::get_property("java.system.class.loader") == nullptr,
763 "archived full module should have been disabled if -Djava.system.class.loader is specified");
764 ClassLoaderDataShared::restore_java_system_loader_from_archive(system_loader_data);
765 }
766
767 void Modules::check_cds_restrictions(Handle module1, Handle module2, TRAPS) {
768 if (CDSConfig::is_dumping_full_module_graph() && Universe::is_module_initialized()) {
769 if (CDSConfig::is_dumping_dynamic_proxies() && (is_dynamic_proxy_module(module1) || is_dynamic_proxy_module(module2))) {
770 // The only the we allow is to add or modify the jdk.proxy?? modules that are used for dynamic proxies.
771 } else {
772 THROW_MSG(vmSymbols::java_lang_UnsupportedOperationException(),
773 "During -Xshare:dump, module system cannot be modified after it's initialized");
774 }
775 }
776 }
777
778 #endif // INCLUDE_CDS_JAVA_HEAP
779
780 bool Modules::is_dynamic_proxy_module(Handle module) {
781 if (!module.is_null()) {
782 ModuleEntry* module_entry = java_lang_Module::module_entry(module());
783 return is_dynamic_proxy_module(module_entry);
784 }
785 return false;
786 }
787
788 bool Modules::is_dynamic_proxy_module(ModuleEntry* module_entry) {
789 return (module_entry != nullptr && module_entry->is_named() && module_entry->name()->starts_with("jdk.proxy"));
790 }
791
792 void Modules::set_bootloader_unnamed_module(Handle module, TRAPS) {
793 ResourceMark rm(THREAD);
794
795 if (module.is_null()) {
796 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null module object");
797 }
798 if (!java_lang_Module::is_instance(module())) {
799 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
800 "module is not an instance of type java.lang.Module");
801 }
802
803 // Ensure that this is an unnamed module
804 oop name = java_lang_Module::name(module());
805 if (name != nullptr) {
806 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
807 "boot loader's unnamed module's java.lang.Module has a name");
808 }
809
810 // Validate java_base's loader is the boot loader.
811 oop loader = java_lang_Module::loader(module());
812 if (loader != nullptr) {
813 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
814 "Class loader must be the boot class loader");
815 }
816
817 log_debug(module)("set_bootloader_unnamed_module(): recording unnamed module for boot loader");
818
819 // Set java.lang.Module for the boot loader's unnamed module
820 ClassLoaderData* boot_loader_data = ClassLoaderData::the_null_class_loader_data();
821 ModuleEntry* unnamed_module = boot_loader_data->unnamed_module();
822 assert(unnamed_module != nullptr, "boot loader's unnamed ModuleEntry not defined");
823 unnamed_module->set_module(boot_loader_data->add_handle(module));
824 // Store pointer to the ModuleEntry in the unnamed module's java.lang.Module object.
825 java_lang_Module::set_module_entry(module(), unnamed_module);
826 }
827
828 void Modules::add_module_exports(Handle from_module, jstring package_name, Handle to_module, TRAPS) {
829 check_cds_restrictions(from_module, to_module, CHECK);
830
831 if (package_name == nullptr) {
832 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
833 "package is null");
834 }
835 if (from_module.is_null()) {
836 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
837 "from_module is null");
838 }
839 ModuleEntry* from_module_entry = get_module_entry(from_module, CHECK);
840 if (from_module_entry == nullptr) {
841 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
842 "from_module cannot be found");
843 }
844
845 // All packages in unnamed and open modules are exported by default.
846 if (!from_module_entry->is_named() || from_module_entry->is_open()) return;
847
848 ModuleEntry* to_module_entry;
849 if (to_module.is_null()) {
850 to_module_entry = nullptr; // It's an unqualified export.
851 } else {
852 to_module_entry = get_module_entry(to_module, CHECK);
853 if (to_module_entry == nullptr) {
854 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
855 "to_module is invalid");
856 }
857 }
858
859 PackageEntry* package_entry = nullptr;
860 char buf[128];
861 int package_len;
862
863 ResourceMark rm(THREAD);
864 const char* pkg = as_internal_package(JNIHandles::resolve_non_null(package_name), buf, sizeof(buf), package_len);
865 {
866 MutexLocker ml(THREAD, Module_lock);
867 package_entry = get_locked_package_entry(from_module_entry, pkg, package_len);
868 // Do nothing if modules are the same
869 // If the package is not found we'll throw an exception later
870 if (from_module_entry != to_module_entry &&
871 package_entry != nullptr) {
872 package_entry->set_exported(to_module_entry);
873 }
874 }
875
876 // Handle errors and logging outside locked section
877 if (package_entry == nullptr) {
878 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
879 err_msg("Package %s not found in from_module %s",
880 pkg != nullptr ? pkg : "",
881 from_module_entry->name()->as_C_string()));
882 }
883
884 if (log_is_enabled(Debug, module)) {
885 log_debug(module)("add_module_exports(): package %s in module %s is exported to module %s",
886 package_entry->name()->as_C_string(),
887 from_module_entry->name()->as_C_string(),
888 to_module_entry == nullptr ? "null" :
889 to_module_entry->is_named() ?
890 to_module_entry->name()->as_C_string() : UNNAMED_MODULE);
891 }
892 }
893
894
895 void Modules::add_module_exports_qualified(Handle from_module, jstring package,
896 Handle to_module, TRAPS) {
897 check_cds_restrictions(from_module, to_module, CHECK);
898 if (to_module.is_null()) {
899 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
900 "to_module is null");
901 }
902 add_module_exports(from_module, package, to_module, CHECK);
903 }
904
905 void Modules::add_reads_module(Handle from_module, Handle to_module, TRAPS) {
906 check_cds_restrictions(from_module, to_module, CHECK);
907 if (from_module.is_null()) {
908 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
909 "from_module is null");
910 }
911
912 ModuleEntry* from_module_entry = get_module_entry(from_module, CHECK);
913 if (from_module_entry == nullptr) {
914 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
915 "from_module is not valid");
916 }
917
918 ModuleEntry* to_module_entry;
919 if (!to_module.is_null()) {
920 to_module_entry = get_module_entry(to_module, CHECK);
921 if (to_module_entry == nullptr) {
922 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
923 "to_module is invalid");
924 }
925 } else {
926 to_module_entry = nullptr;
927 }
928
929 ResourceMark rm(THREAD);
930 log_debug(module)("add_reads_module(): Adding read from module %s to module %s",
931 from_module_entry->is_named() ?
932 from_module_entry->name()->as_C_string() : UNNAMED_MODULE,
933 to_module_entry == nullptr ? "all unnamed" :
934 (to_module_entry->is_named() ?
935 to_module_entry->name()->as_C_string() : UNNAMED_MODULE));
936
937 // if modules are the same or if from_module is unnamed then no need to add the read.
938 if (from_module_entry != to_module_entry && from_module_entry->is_named()) {
939 from_module_entry->add_read(to_module_entry);
940 }
941 }
942
943 // This method is called by JFR and JNI.
944 jobject Modules::get_module(jclass clazz, TRAPS) {
945 assert(ModuleEntryTable::javabase_defined(),
946 "Attempt to call get_module before " JAVA_BASE_NAME " is defined");
947
948 if (clazz == nullptr) {
949 THROW_MSG_(vmSymbols::java_lang_NullPointerException(),
950 "class is null", nullptr);
951 }
952 oop mirror = JNIHandles::resolve_non_null(clazz);
953 if (mirror == nullptr) {
954 log_debug(module)("get_module(): no mirror, returning nullptr");
955 return nullptr;
956 }
957 if (!java_lang_Class::is_instance(mirror)) {
958 THROW_MSG_(vmSymbols::java_lang_IllegalArgumentException(),
959 "Invalid class", nullptr);
960 }
961
962 oop module = java_lang_Class::module(mirror);
963
964 assert(module != nullptr, "java.lang.Class module field not set");
965 assert(java_lang_Module::is_instance(module), "module is not an instance of type java.lang.Module");
966
967 LogTarget(Debug,module) lt;
968 if (lt.is_enabled()) {
969 ResourceMark rm(THREAD);
970 LogStream ls(lt);
971 Klass* klass = java_lang_Class::as_Klass(mirror);
972 oop module_name = java_lang_Module::name(module);
973 if (module_name != nullptr) {
974 ls.print("get_module(): module ");
975 java_lang_String::print(module_name, tty);
976 } else {
977 ls.print("get_module(): Unnamed Module");
978 }
979 if (klass != nullptr) {
980 ls.print_cr(" for class %s", klass->external_name());
981 } else {
982 ls.print_cr(" for primitive class");
983 }
984 }
985
986 return JNIHandles::make_local(THREAD, module);
987 }
988
989 oop Modules::get_named_module(Handle h_loader, const char* package_name) {
990 assert(ModuleEntryTable::javabase_defined(),
991 "Attempt to call get_named_module before " JAVA_BASE_NAME " is defined");
992 assert(h_loader.is_null() || java_lang_ClassLoader::is_subclass(h_loader->klass()),
993 "Class loader is not a subclass of java.lang.ClassLoader");
994 assert(package_name != nullptr, "the package_name should not be null");
995
996 if (strlen(package_name) == 0) {
997 return nullptr;
998 }
999 TempNewSymbol package_sym = SymbolTable::new_symbol(package_name);
1000 const PackageEntry* const pkg_entry =
1001 get_package_entry_by_name(package_sym, h_loader);
1002 const ModuleEntry* const module_entry = (pkg_entry != nullptr ? pkg_entry->module() : nullptr);
1003
1004 if (module_entry != nullptr && module_entry->module() != nullptr && module_entry->is_named()) {
1005 return module_entry->module();
1006 }
1007 return nullptr;
1008 }
1009
1010 // Export package in module to all unnamed modules.
1011 void Modules::add_module_exports_to_all_unnamed(Handle module, jstring package_name, TRAPS) {
1012 check_cds_restrictions(Handle(), module, CHECK);
1013 if (module.is_null()) {
1014 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
1015 "module is null");
1016 }
1017 if (package_name == nullptr) {
1018 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
1019 "package is null");
1020 }
1021 ModuleEntry* module_entry = get_module_entry(module, CHECK);
1022 if (module_entry == nullptr) {
1023 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
1024 "module is invalid");
1025 }
1026
1027 // No-op for unnamed module and open modules
1028 if (!module_entry->is_named() || module_entry->is_open())
1029 return;
1030
1031 ResourceMark rm(THREAD);
1032 char buf[128];
1033 int pkg_len;
1034 const char* pkg = as_internal_package(JNIHandles::resolve_non_null(package_name), buf, sizeof(buf), pkg_len);
1035 PackageEntry* package_entry = nullptr;
1036 {
1037 MutexLocker m1(THREAD, Module_lock);
1038 package_entry = get_locked_package_entry(module_entry, pkg, pkg_len);
1039
1040 // Mark package as exported to all unnamed modules.
1041 if (package_entry != nullptr) {
1042 package_entry->set_is_exported_allUnnamed();
1043 }
1044 }
1045
1046 // Handle errors and logging outside locked section
1047 if (package_entry == nullptr) {
1048 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
1049 err_msg("Package %s not found in module %s",
1050 pkg != nullptr ? pkg : "",
1051 module_entry->name()->as_C_string()));
1052 }
1053
1054 if (log_is_enabled(Debug, module)) {
1055 log_debug(module)("add_module_exports_to_all_unnamed(): package %s in module"
1056 " %s is exported to all unnamed modules",
1057 package_entry->name()->as_C_string(),
1058 module_entry->name()->as_C_string());
1059 }
1060 }