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