1 /*
   2 * Copyright (c) 2016, 2017, 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 "classfile/classFileParser.hpp"
  27 #include "classfile/classLoader.hpp"
  28 #include "classfile/classLoaderData.inline.hpp"
  29 #include "classfile/javaAssertions.hpp"
  30 #include "classfile/javaClasses.hpp"
  31 #include "classfile/javaClasses.inline.hpp"
  32 #include "classfile/moduleEntry.hpp"
  33 #include "classfile/modules.hpp"
  34 #include "classfile/packageEntry.hpp"
  35 #include "classfile/stringTable.hpp"
  36 #include "classfile/symbolTable.hpp"
  37 #include "classfile/systemDictionary.hpp"
  38 #include "classfile/vmSymbols.hpp"
  39 #include "logging/log.hpp"
  40 #include "memory/resourceArea.hpp"
  41 #include "oops/instanceKlass.hpp"
  42 #include "runtime/arguments.hpp"
  43 #include "runtime/handles.inline.hpp"
  44 #include "runtime/javaCalls.hpp"
  45 #include "runtime/reflection.hpp"
  46 #include "utilities/stringUtils.hpp"
  47 #include "utilities/utf8.hpp"
  48 
  49 static bool verify_module_name(const char *module_name) {
  50   if (module_name == NULL) return false;
  51   int len = (int)strlen(module_name);
  52   return (len > 0 && len <= Symbol::max_length());
  53 }
  54 
  55 bool Modules::verify_package_name(const char* package_name) {
  56   if (package_name == NULL) return false;
  57   int len = (int)strlen(package_name);
  58   return (len > 0 && len <= Symbol::max_length() &&
  59     UTF8::is_legal_utf8((const unsigned char *)package_name, len, false) &&
  60     ClassFileParser::verify_unqualified_name(package_name, len,
  61     ClassFileParser::LegalClass));
  62 }
  63 
  64 static char* get_module_name(oop module, TRAPS) {
  65   oop name_oop = java_lang_reflect_Module::name(module);
  66   if (name_oop == NULL) {
  67     THROW_MSG_NULL(vmSymbols::java_lang_NullPointerException(), "Null module name");
  68   }
  69   char* module_name = java_lang_String::as_utf8_string(name_oop);
  70   if (!verify_module_name(module_name)) {
  71     THROW_MSG_NULL(vmSymbols::java_lang_IllegalArgumentException(),
  72                    err_msg("Invalid module name: %s",
  73                            module_name != NULL ? module_name : "NULL"));
  74   }
  75   return module_name;
  76 }
  77 
  78 static const char* get_module_version(jstring version) {
  79   if (version == NULL) {
  80     return NULL;
  81   }
  82   return java_lang_String::as_utf8_string(JNIHandles::resolve_non_null(version));
  83 }
  84 
  85 static ModuleEntryTable* get_module_entry_table(Handle h_loader, TRAPS) {
  86   // This code can be called during start-up, before the classLoader's classLoader data got
  87   // created.  So, call register_loader() to make sure the classLoader data gets created.
  88   ClassLoaderData *loader_cld = SystemDictionary::register_loader(h_loader, CHECK_NULL);
  89   return loader_cld->modules();
  90 }
  91 
  92 static PackageEntryTable* get_package_entry_table(Handle h_loader, TRAPS) {
  93   // This code can be called during start-up, before the classLoader's classLoader data got
  94   // created.  So, call register_loader() to make sure the classLoader data gets created.
  95   ClassLoaderData *loader_cld = SystemDictionary::register_loader(h_loader, CHECK_NULL);
  96   return loader_cld->packages();
  97 }
  98 
  99 static ModuleEntry* get_module_entry(jobject module, TRAPS) {
 100   Handle module_h(THREAD, JNIHandles::resolve(module));
 101   if (!java_lang_reflect_Module::is_instance(module_h())) {
 102     THROW_MSG_NULL(vmSymbols::java_lang_IllegalArgumentException(),
 103                    "module is not an instance of type java.lang.reflect.Module");
 104   }
 105   return java_lang_reflect_Module::module_entry(module_h(), CHECK_NULL);
 106 }
 107 
 108 static PackageEntry* get_package_entry(ModuleEntry* module_entry, const char* package_name, TRAPS) {
 109   ResourceMark rm(THREAD);
 110   if (package_name == NULL) return NULL;
 111   TempNewSymbol pkg_symbol = SymbolTable::new_symbol(package_name, CHECK_NULL);
 112   PackageEntryTable* package_entry_table = module_entry->loader_data()->packages();
 113   assert(package_entry_table != NULL, "Unexpected null package entry table");
 114   return package_entry_table->lookup_only(pkg_symbol);
 115 }
 116 
 117 static PackageEntry* get_package_entry_by_name(Symbol* package,
 118                                                Handle h_loader,
 119                                                TRAPS) {
 120   if (package != NULL) {
 121     ResourceMark rm(THREAD);
 122     if (Modules::verify_package_name(package->as_C_string())) {
 123       PackageEntryTable* const package_entry_table =
 124         get_package_entry_table(h_loader, CHECK_NULL);
 125       assert(package_entry_table != NULL, "Unexpected null package entry table");
 126       return package_entry_table->lookup_only(package);
 127     }
 128   }
 129   return NULL;
 130 }
 131 
 132 bool Modules::is_package_defined(Symbol* package, Handle h_loader, TRAPS) {
 133   PackageEntry* res = get_package_entry_by_name(package, h_loader, CHECK_false);
 134   return res != NULL;
 135 }
 136 
 137 static void define_javabase_module(jobject module, jstring version,
 138                                    jstring location, const char* const* packages,
 139                                    jsize num_packages, TRAPS) {
 140   ResourceMark rm(THREAD);
 141 
 142   Handle module_handle(THREAD, JNIHandles::resolve(module));
 143 
 144   // Obtain java.base's module version
 145   const char* module_version = get_module_version(version);
 146   TempNewSymbol version_symbol;
 147   if (module_version != NULL) {
 148     version_symbol = SymbolTable::new_symbol(module_version, CHECK);
 149   } else {
 150     version_symbol = NULL;
 151   }
 152 
 153   // Obtain java.base's location
 154   const char* module_location = NULL;
 155   TempNewSymbol location_symbol = NULL;
 156   if (location != NULL) {
 157     module_location =
 158       java_lang_String::as_utf8_string(JNIHandles::resolve_non_null(location));
 159     if (module_location != NULL) {
 160       location_symbol = SymbolTable::new_symbol(module_location, CHECK);
 161     }
 162   }
 163 
 164 
 165   // Check that the packages are syntactically ok.
 166   GrowableArray<Symbol*>* pkg_list = new GrowableArray<Symbol*>(num_packages);
 167   for (int x = 0; x < num_packages; x++) {
 168     const char *package_name = packages[x];
 169     if (!Modules::verify_package_name(package_name)) {
 170       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 171                 err_msg("Invalid package name: %s for module: " JAVA_BASE_NAME, package_name));
 172     }
 173     Symbol* pkg_symbol = SymbolTable::new_symbol(package_name, CHECK);
 174     pkg_list->append(pkg_symbol);
 175   }
 176 
 177   // Validate java_base's loader is the boot loader.
 178   oop loader = java_lang_reflect_Module::loader(module_handle());
 179   if (loader != NULL) {
 180     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 181               "Class loader must be the boot class loader");
 182   }
 183   Handle h_loader(THREAD, loader);
 184 
 185   // Ensure the boot loader's PackageEntryTable has been created
 186   PackageEntryTable* package_table = get_package_entry_table(h_loader, CHECK);
 187   assert(pkg_list->length() == 0 || package_table != NULL, "Bad package_table");
 188 
 189   // Ensure java.base's ModuleEntry has been created
 190   assert(ModuleEntryTable::javabase_moduleEntry() != NULL, "No ModuleEntry for " JAVA_BASE_NAME);
 191 
 192   bool duplicate_javabase = false;
 193   {
 194     MutexLocker m1(Module_lock, THREAD);
 195 
 196     if (ModuleEntryTable::javabase_defined()) {
 197       duplicate_javabase = true;
 198     } else {
 199 
 200       // Verify that all java.base packages created during bootstrapping are in
 201       // pkg_list.  If any are not in pkg_list, than a non-java.base class was
 202       // loaded erroneously pre java.base module definition.
 203       package_table->verify_javabase_packages(pkg_list);
 204 
 205       // loop through and add any new packages for java.base
 206       PackageEntry* pkg;
 207       for (int x = 0; x < pkg_list->length(); x++) {
 208         // Some of java.base's packages were added early in bootstrapping, ignore duplicates.
 209         if (package_table->lookup_only(pkg_list->at(x)) == NULL) {
 210           pkg = package_table->locked_create_entry_or_null(pkg_list->at(x), ModuleEntryTable::javabase_moduleEntry());
 211           assert(pkg != NULL, "Unable to create a " JAVA_BASE_NAME " package entry");
 212         }
 213         // Unable to have a GrowableArray of TempNewSymbol.  Must decrement the refcount of
 214         // the Symbol* that was created above for each package. The refcount was incremented
 215         // by SymbolTable::new_symbol and as well by the PackageEntry creation.
 216         pkg_list->at(x)->decrement_refcount();
 217       }
 218 
 219       // Finish defining java.base's ModuleEntry
 220       ModuleEntryTable::finalize_javabase(module_handle, version_symbol, location_symbol);
 221     }
 222   }
 223   if (duplicate_javabase) {
 224     THROW_MSG(vmSymbols::java_lang_InternalError(),
 225               "Module " JAVA_BASE_NAME " is already defined");
 226   }
 227 
 228   // Only the thread that actually defined the base module will get here,
 229   // so no locking is needed.
 230 
 231   // Patch any previously loaded class's module field with java.base's java.lang.reflect.Module.
 232   ModuleEntryTable::patch_javabase_entries(module_handle);
 233 
 234   log_debug(modules)("define_javabase_module(): Definition of module: "
 235                      JAVA_BASE_NAME ", version: %s, location: %s, package #: %d",
 236                      module_version != NULL ? module_version : "NULL",
 237                      module_location != NULL ? module_location : "NULL",
 238                      pkg_list->length());
 239 
 240   // packages defined to java.base
 241   for (int x = 0; x < pkg_list->length(); x++) {
 242     log_trace(modules)("define_javabase_module(): creation of package %s for module " JAVA_BASE_NAME,
 243                        (pkg_list->at(x))->as_C_string());
 244   }
 245 }
 246 
 247 // Caller needs ResourceMark.
 248 void throw_dup_pkg_exception(const char* module_name, PackageEntry* package, TRAPS) {
 249   const char* package_name = package->name()->as_C_string();
 250   if (package->module()->is_named()) {
 251     THROW_MSG(vmSymbols::java_lang_IllegalStateException(),
 252       err_msg("Package %s for module %s is already in another module, %s, defined to the class loader",
 253               package_name, module_name, package->module()->name()->as_C_string()));
 254   } else {
 255     THROW_MSG(vmSymbols::java_lang_IllegalStateException(),
 256       err_msg("Package %s for module %s is already in the unnamed module defined to the class loader",
 257               package_name, module_name));
 258   }
 259 }
 260 
 261 void Modules::define_module(jobject module, jstring version,
 262                             jstring location, const char* const* packages,
 263                             jsize num_packages, TRAPS) {
 264   ResourceMark rm(THREAD);
 265 
 266   if (module == NULL) {
 267     THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null module object");
 268   }
 269 
 270   if (num_packages < 0) {
 271     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 272               "num_packages must be >= 0");
 273   }
 274 
 275   if (packages == NULL && num_packages > 0) {
 276     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 277               "num_packages should be zero if packages is null");
 278   }
 279 
 280   Handle module_handle(THREAD, JNIHandles::resolve(module));
 281   if (!java_lang_reflect_Module::is_instance(module_handle())) {
 282     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 283               "module is not an instance of type java.lang.reflect.Module");
 284   }
 285 
 286   char* module_name = get_module_name(module_handle(), CHECK);
 287   if (module_name == NULL) {
 288     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 289               "Module name cannot be null");
 290   }
 291 
 292   // Special handling of java.base definition
 293   if (strcmp(module_name, JAVA_BASE_NAME) == 0) {
 294     define_javabase_module(module, version, location, packages, num_packages, CHECK);
 295     return;
 296   }
 297 
 298   const char* module_version = get_module_version(version);
 299 
 300   oop loader = java_lang_reflect_Module::loader(module_handle());
 301   // Make sure loader is not the jdk.internal.reflect.DelegatingClassLoader.
 302   if (loader != java_lang_ClassLoader::non_reflection_class_loader(loader)) {
 303     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 304               "Class loader is an invalid delegating class loader");
 305   }
 306   Handle h_loader = Handle(THREAD, loader);
 307 
 308   // Check that the list of packages has no duplicates and that the
 309   // packages are syntactically ok.
 310   GrowableArray<Symbol*>* pkg_list = new GrowableArray<Symbol*>(num_packages);
 311   for (int x = 0; x < num_packages; x++) {
 312     const char* package_name = packages[x];
 313     if (!verify_package_name(package_name)) {
 314       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 315                 err_msg("Invalid package name: %s for module: %s",
 316                         package_name, module_name));
 317     }
 318 
 319     // Only modules defined to either the boot or platform class loader, can define a "java/" package.
 320     if (!h_loader.is_null() &&
 321         !SystemDictionary::is_platform_class_loader(h_loader()) &&
 322         (strncmp(package_name, JAVAPKG, JAVAPKG_LEN) == 0 &&
 323           (package_name[JAVAPKG_LEN] == '/' || package_name[JAVAPKG_LEN] == '\0'))) {
 324       const char* class_loader_name = SystemDictionary::loader_name(h_loader());
 325       size_t pkg_len = strlen(package_name);
 326       char* pkg_name = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, pkg_len);
 327       strncpy(pkg_name, package_name, pkg_len);
 328       StringUtils::replace_no_expand(pkg_name, "/", ".");
 329       const char* msg_text1 = "Class loader (instance of): ";
 330       const char* msg_text2 = " tried to define prohibited package name: ";
 331       size_t len = strlen(msg_text1) + strlen(class_loader_name) + strlen(msg_text2) + pkg_len + 1;
 332       char* message = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, len);
 333       jio_snprintf(message, len, "%s%s%s%s", msg_text1, class_loader_name, msg_text2, pkg_name);
 334       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), message);
 335     }
 336 
 337     Symbol* pkg_symbol = SymbolTable::new_symbol(package_name, CHECK);
 338     pkg_list->append(pkg_symbol);
 339   }
 340 
 341   ModuleEntryTable* module_table = get_module_entry_table(h_loader, CHECK);
 342   assert(module_table != NULL, "module entry table shouldn't be null");
 343 
 344   // Create symbol* entry for module name.
 345   TempNewSymbol module_symbol = SymbolTable::new_symbol(module_name, CHECK);
 346 
 347   bool dupl_modules = false;
 348 
 349   // Create symbol* entry for module version.
 350   TempNewSymbol version_symbol;
 351   if (module_version != NULL) {
 352     version_symbol = SymbolTable::new_symbol(module_version, CHECK);
 353   } else {
 354     version_symbol = NULL;
 355   }
 356 
 357   // Create symbol* entry for module location.
 358   const char* module_location = NULL;
 359   TempNewSymbol location_symbol = NULL;
 360   if (location != NULL) {
 361     module_location =
 362       java_lang_String::as_utf8_string(JNIHandles::resolve_non_null(location));
 363     if (module_location != NULL) {
 364       location_symbol = SymbolTable::new_symbol(module_location, CHECK);
 365     }
 366   }
 367 
 368   ClassLoaderData* loader_data = ClassLoaderData::class_loader_data_or_null(h_loader());
 369   assert(loader_data != NULL, "class loader data shouldn't be null");
 370 
 371   PackageEntryTable* package_table = NULL;
 372   PackageEntry* existing_pkg = NULL;
 373   {
 374     MutexLocker ml(Module_lock, THREAD);
 375 
 376     if (num_packages > 0) {
 377       package_table = get_package_entry_table(h_loader, CHECK);
 378       assert(package_table != NULL, "Missing package_table");
 379 
 380       // Check that none of the packages exist in the class loader's package table.
 381       for (int x = 0; x < pkg_list->length(); x++) {
 382         existing_pkg = package_table->lookup_only(pkg_list->at(x));
 383         if (existing_pkg != NULL) {
 384           // This could be because the module was already defined.  If so,
 385           // report that error instead of the package error.
 386           if (module_table->lookup_only(module_symbol) != NULL) {
 387             dupl_modules = true;
 388           }
 389           break;
 390         }
 391       }
 392     }  // if (num_packages > 0)...
 393 
 394     // Add the module and its packages.
 395     if (!dupl_modules && existing_pkg == NULL) {
 396       // Create the entry for this module in the class loader's module entry table.
 397       ModuleEntry* module_entry = module_table->locked_create_entry_or_null(module_handle, module_symbol,
 398                                     version_symbol, location_symbol, loader_data);
 399 
 400       if (module_entry == NULL) {
 401         dupl_modules = true;
 402       } else {
 403         // Add the packages.
 404         assert(pkg_list->length() == 0 || package_table != NULL, "Bad package table");
 405         PackageEntry* pkg;
 406         for (int y = 0; y < pkg_list->length(); y++) {
 407           pkg = package_table->locked_create_entry_or_null(pkg_list->at(y), module_entry);
 408           assert(pkg != NULL, "Unable to create a module's package entry");
 409 
 410           // Unable to have a GrowableArray of TempNewSymbol.  Must decrement the refcount of
 411           // the Symbol* that was created above for each package. The refcount was incremented
 412           // by SymbolTable::new_symbol and as well by the PackageEntry creation.
 413           pkg_list->at(y)->decrement_refcount();
 414         }
 415 
 416         // Store pointer to ModuleEntry record in java.lang.reflect.Module object.
 417         java_lang_reflect_Module::set_module_entry(module_handle(), module_entry);
 418       }
 419     }
 420   }  // Release the lock
 421 
 422   // any errors ?
 423   if (dupl_modules) {
 424      THROW_MSG(vmSymbols::java_lang_IllegalStateException(),
 425                err_msg("Module %s is already defined", module_name));
 426   } else if (existing_pkg != NULL) {
 427       throw_dup_pkg_exception(module_name, existing_pkg, CHECK);
 428   }
 429 
 430   if (log_is_enabled(Debug, modules)) {
 431     outputStream* logst = Log(modules)::debug_stream();
 432     logst->print("define_module(): creation of module: %s, version: %s, location: %s, ",
 433                  module_name, module_version != NULL ? module_version : "NULL",
 434                  module_location != NULL ? module_location : "NULL");
 435     loader_data->print_value_on(logst);
 436     logst->print_cr(", package #: %d", pkg_list->length());
 437     for (int y = 0; y < pkg_list->length(); y++) {
 438       log_trace(modules)("define_module(): creation of package %s for module %s",
 439                          (pkg_list->at(y))->as_C_string(), module_name);
 440     }
 441   }
 442 
 443   // If the module is defined to the boot loader and an exploded build is being
 444   // used, prepend <java.home>/modules/modules_name, if it exists, to the system boot class path.
 445   if (loader == NULL &&
 446       !Universe::is_module_initialized() &&
 447       !ClassLoader::has_jrt_entry()) {
 448     ClassLoader::add_to_exploded_build_list(module_symbol, CHECK);
 449   }
 450 }
 451 
 452 void Modules::set_bootloader_unnamed_module(jobject module, TRAPS) {
 453   ResourceMark rm(THREAD);
 454 
 455   if (module == NULL) {
 456     THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null module object");
 457   }
 458   Handle module_handle(THREAD, JNIHandles::resolve(module));
 459   if (!java_lang_reflect_Module::is_instance(module_handle())) {
 460     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 461               "module is not an instance of type java.lang.reflect.Module");
 462   }
 463 
 464   // Ensure that this is an unnamed module
 465   oop name = java_lang_reflect_Module::name(module_handle());
 466   if (name != NULL) {
 467     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 468               "boot loader's unnamed module's java.lang.reflect.Module has a name");
 469   }
 470 
 471   // Validate java_base's loader is the boot loader.
 472   oop loader = java_lang_reflect_Module::loader(module_handle());
 473   if (loader != NULL) {
 474     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 475               "Class loader must be the boot class loader");
 476   }
 477   Handle h_loader(THREAD, loader);
 478 
 479   log_debug(modules)("set_bootloader_unnamed_module(): recording unnamed module for boot loader");
 480 
 481   // Ensure the boot loader's PackageEntryTable has been created
 482   ModuleEntryTable* module_table = get_module_entry_table(h_loader, CHECK);
 483 
 484   // Set java.lang.reflect.Module for the boot loader's unnamed module
 485   ModuleEntry* unnamed_module = module_table->unnamed_module();
 486   assert(unnamed_module != NULL, "boot loader's unnamed ModuleEntry not defined");
 487   unnamed_module->set_module(ClassLoaderData::the_null_class_loader_data()->add_handle(module_handle));
 488   // Store pointer to the ModuleEntry in the unnamed module's java.lang.reflect.Module object.
 489   java_lang_reflect_Module::set_module_entry(module_handle(), unnamed_module);
 490 }
 491 
 492 void Modules::add_module_exports(jobject from_module, const char* package_name, jobject to_module, TRAPS) {
 493   if (package_name == NULL) {
 494     THROW_MSG(vmSymbols::java_lang_NullPointerException(),
 495               "package is null");
 496   }
 497   if (from_module == NULL) {
 498     THROW_MSG(vmSymbols::java_lang_NullPointerException(),
 499               "from_module is null");
 500   }
 501   ModuleEntry* from_module_entry = get_module_entry(from_module, CHECK);
 502   if (from_module_entry == NULL) {
 503     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 504               "from_module cannot be found");
 505   }
 506 
 507   // All packages in unnamed are exported by default.
 508   if (!from_module_entry->is_named()) return;
 509 
 510   ModuleEntry* to_module_entry;
 511   if (to_module == NULL) {
 512     to_module_entry = NULL;  // It's an unqualified export.
 513   } else {
 514     to_module_entry = get_module_entry(to_module, CHECK);
 515     if (to_module_entry == NULL) {
 516       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 517                 "to_module is invalid");
 518     }
 519   }
 520 
 521   PackageEntry *package_entry = get_package_entry(from_module_entry, package_name, CHECK);
 522   ResourceMark rm(THREAD);
 523   if (package_entry == NULL) {
 524     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 525               err_msg("Package %s not found in from_module %s",
 526                       package_name != NULL ? package_name : "",
 527                       from_module_entry->name()->as_C_string()));
 528   }
 529   if (package_entry->module() != from_module_entry) {
 530     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 531               err_msg("Package: %s found in module %s, not in from_module: %s",
 532                       package_entry->name()->as_C_string(),
 533                       package_entry->module()->name()->as_C_string(),
 534                       from_module_entry->name()->as_C_string()));
 535   }
 536 
 537   log_debug(modules)("add_module_exports(): package %s in module %s is exported to module %s",
 538                      package_entry->name()->as_C_string(),
 539                      from_module_entry->name()->as_C_string(),
 540                      to_module_entry == NULL ? "NULL" :
 541                       to_module_entry->is_named() ?
 542                         to_module_entry->name()->as_C_string() : UNNAMED_MODULE);
 543 
 544   // Do nothing if modules are the same.
 545   if (from_module_entry != to_module_entry) {
 546     package_entry->set_exported(to_module_entry);
 547   }
 548 }
 549 
 550 
 551 void Modules::add_module_exports_qualified(jobject from_module, const char* package,
 552                                            jobject to_module, TRAPS) {
 553   if (to_module == NULL) {
 554     THROW_MSG(vmSymbols::java_lang_NullPointerException(),
 555               "to_module is null");
 556   }
 557   add_module_exports(from_module, package, to_module, CHECK);
 558 }
 559 
 560 void Modules::add_reads_module(jobject from_module, jobject to_module, TRAPS) {
 561   if (from_module == NULL) {
 562     THROW_MSG(vmSymbols::java_lang_NullPointerException(),
 563               "from_module is null");
 564   }
 565 
 566   ModuleEntry* from_module_entry = get_module_entry(from_module, CHECK);
 567   if (from_module_entry == NULL) {
 568     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 569               "from_module is not valid");
 570   }
 571 
 572   ModuleEntry* to_module_entry;
 573   if (to_module != NULL) {
 574     to_module_entry = get_module_entry(to_module, CHECK);
 575     if (to_module_entry == NULL) {
 576       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 577                 "to_module is invalid");
 578     }
 579   } else {
 580     to_module_entry = NULL;
 581   }
 582 
 583   ResourceMark rm(THREAD);
 584   log_debug(modules)("add_reads_module(): Adding read from module %s to module %s",
 585                      from_module_entry->is_named() ?
 586                      from_module_entry->name()->as_C_string() : UNNAMED_MODULE,
 587                      to_module_entry == NULL ? "all unnamed" :
 588                        (to_module_entry->is_named() ?
 589                         to_module_entry->name()->as_C_string() : UNNAMED_MODULE));
 590 
 591   // if modules are the same or if from_module is unnamed then no need to add the read.
 592   if (from_module_entry != to_module_entry && from_module_entry->is_named()) {
 593     from_module_entry->add_read(to_module_entry);
 594   }
 595 }
 596 
 597 // This method is called by JFR and JNI.
 598 jobject Modules::get_module(jclass clazz, TRAPS) {
 599   assert(ModuleEntryTable::javabase_defined(),
 600          "Attempt to call get_module before " JAVA_BASE_NAME " is defined");
 601 
 602   if (clazz == NULL) {
 603     THROW_MSG_(vmSymbols::java_lang_NullPointerException(),
 604                "class is null", JNI_FALSE);
 605   }
 606   oop mirror = JNIHandles::resolve_non_null(clazz);
 607   if (mirror == NULL) {
 608     log_debug(modules)("get_module(): no mirror, returning NULL");
 609     return NULL;
 610   }
 611   if (!java_lang_Class::is_instance(mirror)) {
 612     THROW_MSG_(vmSymbols::java_lang_IllegalArgumentException(),
 613                "Invalid class", JNI_FALSE);
 614   }
 615 
 616   oop module = java_lang_Class::module(mirror);
 617 
 618   assert(module != NULL, "java.lang.Class module field not set");
 619   assert(java_lang_reflect_Module::is_instance(module), "module is not an instance of type java.lang.reflect.Module");
 620 
 621   if (log_is_enabled(Debug, modules)) {
 622     ResourceMark rm(THREAD);
 623     outputStream* logst = Log(modules)::debug_stream();
 624     Klass* klass = java_lang_Class::as_Klass(mirror);
 625     oop module_name = java_lang_reflect_Module::name(module);
 626     if (module_name != NULL) {
 627       logst->print("get_module(): module ");
 628       java_lang_String::print(module_name, tty);
 629     } else {
 630       logst->print("get_module(): Unamed Module");
 631     }
 632     if (klass != NULL) {
 633       logst->print_cr(" for class %s", klass->external_name());
 634     } else {
 635       logst->print_cr(" for primitive class");
 636     }
 637   }
 638 
 639   return JNIHandles::make_local(THREAD, module);
 640 }
 641 
 642 jobject Modules::get_named_module(Handle h_loader, const char* package_name, TRAPS) {
 643   assert(ModuleEntryTable::javabase_defined(),
 644          "Attempt to call get_named_module before " JAVA_BASE_NAME " is defined");
 645   assert(h_loader.is_null() || java_lang_ClassLoader::is_subclass(h_loader->klass()),
 646          "Class loader is not a subclass of java.lang.ClassLoader");
 647   assert(package_name != NULL, "the package_name should not be NULL");
 648 
 649   if (strlen(package_name) == 0) {
 650     return NULL;
 651   }
 652   TempNewSymbol package_sym = SymbolTable::new_symbol(package_name, CHECK_NULL);
 653   const PackageEntry* const pkg_entry =
 654     get_package_entry_by_name(package_sym, h_loader, THREAD);
 655   const ModuleEntry* const module_entry = (pkg_entry != NULL ? pkg_entry->module() : NULL);
 656 
 657   if (module_entry != NULL && module_entry->module() != NULL && module_entry->is_named()) {
 658     return JNIHandles::make_local(THREAD, JNIHandles::resolve(module_entry->module()));
 659   }
 660   return NULL;
 661 }
 662 
 663 
 664 // This method is called by JFR and by the above method.
 665 jobject Modules::get_module(Symbol* package_name, Handle h_loader, TRAPS) {
 666   const PackageEntry* const pkg_entry =
 667     get_package_entry_by_name(package_name, h_loader, THREAD);
 668   const ModuleEntry* const module_entry = (pkg_entry != NULL ? pkg_entry->module() : NULL);
 669 
 670   if (module_entry != NULL &&
 671       module_entry->module() != NULL) {
 672     return JNIHandles::make_local(THREAD, JNIHandles::resolve(module_entry->module()));
 673   }
 674 
 675   return NULL;
 676 }
 677 
 678 void Modules::add_module_package(jobject module, const char* package_name, TRAPS) {
 679   ResourceMark rm(THREAD);
 680 
 681   if (module == NULL) {
 682     THROW_MSG(vmSymbols::java_lang_NullPointerException(),
 683               "module is null");
 684   }
 685   if (package_name == NULL) {
 686     THROW_MSG(vmSymbols::java_lang_NullPointerException(),
 687               "package is null");
 688   }
 689   ModuleEntry* module_entry = get_module_entry(module, CHECK);
 690   if (module_entry == NULL) {
 691     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 692               "module is invalid");
 693   }
 694   if (!module_entry->is_named()) {
 695     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 696               "module cannot be an unnamed module");
 697   }
 698   if (!verify_package_name(package_name)) {
 699     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 700               err_msg("Invalid package name: %s", package_name));
 701   }
 702 
 703   ClassLoaderData *loader_data = module_entry->loader_data();
 704 
 705   // Only modules defined to either the boot or platform class loader, can define a "java/" package.
 706   if (!loader_data->is_the_null_class_loader_data() &&
 707       !loader_data->is_platform_class_loader_data() &&
 708       (strncmp(package_name, JAVAPKG, JAVAPKG_LEN) == 0 &&
 709         (package_name[JAVAPKG_LEN] == '/' || package_name[JAVAPKG_LEN] == '\0'))) {
 710     const char* class_loader_name = SystemDictionary::loader_name(loader_data);
 711     size_t pkg_len = strlen(package_name);
 712     char* pkg_name = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, pkg_len);
 713     strncpy(pkg_name, package_name, pkg_len);
 714     StringUtils::replace_no_expand(pkg_name, "/", ".");
 715     const char* msg_text1 = "Class loader (instance of): ";
 716     const char* msg_text2 = " tried to define prohibited package name: ";
 717     size_t len = strlen(msg_text1) + strlen(class_loader_name) + strlen(msg_text2) + pkg_len + 1;
 718     char* message = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, len);
 719     jio_snprintf(message, len, "%s%s%s%s", msg_text1, class_loader_name, msg_text2, pkg_name);
 720     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), message);
 721   }
 722 
 723   log_debug(modules)("add_module_package(): Adding package %s to module %s",
 724                      package_name, module_entry->name()->as_C_string());
 725 
 726   TempNewSymbol pkg_symbol = SymbolTable::new_symbol(package_name, CHECK);
 727   PackageEntryTable* package_table = loader_data->packages();
 728   assert(package_table != NULL, "Missing package_table");
 729 
 730   PackageEntry* existing_pkg = NULL;
 731   {
 732     MutexLocker ml(Module_lock, THREAD);
 733 
 734     // Check that the package does not exist in the class loader's package table.
 735     existing_pkg = package_table->lookup_only(pkg_symbol);
 736     if (existing_pkg == NULL) {
 737       PackageEntry* pkg = package_table->locked_create_entry_or_null(pkg_symbol, module_entry);
 738       assert(pkg != NULL, "Unable to create a module's package entry");
 739     }
 740   }
 741   if (existing_pkg != NULL) {
 742     throw_dup_pkg_exception(module_entry->name()->as_C_string(), existing_pkg, CHECK);
 743   }
 744 }
 745 
 746 // Export package in module to all unnamed modules.
 747 void Modules::add_module_exports_to_all_unnamed(jobject module, const char* package_name, TRAPS) {
 748   if (module == NULL) {
 749     THROW_MSG(vmSymbols::java_lang_NullPointerException(),
 750               "module is null");
 751   }
 752   if (package_name == NULL) {
 753     THROW_MSG(vmSymbols::java_lang_NullPointerException(),
 754               "package is null");
 755   }
 756   ModuleEntry* module_entry = get_module_entry(module, CHECK);
 757   if (module_entry == NULL) {
 758     THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 759               "module is invalid");
 760   }
 761 
 762   if (module_entry->is_named()) { // No-op for unnamed module.
 763     PackageEntry *package_entry = get_package_entry(module_entry, package_name, CHECK);
 764     ResourceMark rm(THREAD);
 765     if (package_entry == NULL) {
 766       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 767                 err_msg("Package %s not found in module %s",
 768                         package_name != NULL ? package_name : "",
 769                         module_entry->name()->as_C_string()));
 770     }
 771     if (package_entry->module() != module_entry) {
 772       THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
 773                 err_msg("Package: %s found in module %s, not in module: %s",
 774                         package_entry->name()->as_C_string(),
 775                         package_entry->module()->name()->as_C_string(),
 776                         module_entry->name()->as_C_string()));
 777     }
 778 
 779     log_debug(modules)("add_module_exports_to_all_unnamed(): package %s in module"
 780                        " %s is exported to all unnamed modules",
 781                        package_entry->name()->as_C_string(),
 782                        module_entry->name()->as_C_string());
 783 
 784     // Mark package as exported to all unnamed modules.
 785     package_entry->set_is_exported_allUnnamed();
 786   }
 787 }