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