1 /* 2 * Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 * 23 */ 24 25 #ifndef SHARE_CLASSFILE_MODULES_HPP 26 #define SHARE_CLASSFILE_MODULES_HPP 27 28 #include "memory/allStatic.hpp" 29 #include "runtime/handles.hpp" 30 31 class ModuleEntryTable; 32 class SerializeClosure; 33 class Symbol; 34 35 class Modules : AllStatic { 36 static void check_cds_restrictions(TRAPS) NOT_CDS_JAVA_HEAP_RETURN; 37 38 public: 39 // define_module defines a module containing the specified packages. It binds the 40 // module to its class loader by creating the ModuleEntry record in the 41 // ClassLoader's ModuleEntry table, and creates PackageEntry records in the class 42 // loader's PackageEntry table. The jstring for all package names will convert "." 43 // to "/" 44 // 45 // IllegalArgumentExceptions are thrown for the following : 46 // * Module's Class loader is not a subclass of java.lang.ClassLoader 47 // * Module's Class loader already has a module with that name 48 // * Module's Class loader has already defined types for any of the module's packages 49 // * Module_name is syntactically bad 50 // * Packages contains an illegal package name or a non-String object 51 // * A package already exists in another module for this class loader 52 // * Module is an unnamed module 53 // NullPointerExceptions are thrown if module is null. 54 static void define_module(Handle module, jboolean is_open, jstring version, 55 jstring location, jobjectArray packages, TRAPS); 56 57 static void check_archived_module_oop(oop orig_module_obj) NOT_CDS_JAVA_HEAP_RETURN; 58 static void define_archived_modules(Handle h_platform_loader, Handle h_system_loader, 59 TRAPS) NOT_CDS_JAVA_HEAP_RETURN; 60 static void init_archived_modules(JavaThread* current, Handle h_platform_loader, Handle h_system_loader) 61 NOT_CDS_JAVA_HEAP_RETURN; 62 static void verify_archived_modules() NOT_CDS_JAVA_HEAP_RETURN; 63 static void dump_archived_module_info() NOT_CDS_JAVA_HEAP_RETURN; 64 static void serialize_archived_module_info(SerializeClosure* soc) NOT_CDS_JAVA_HEAP_RETURN; 65 66 #if INCLUDE_CDS_JAVA_HEAP 67 private: 68 class ArchivedProperty; 69 70 static ArchivedProperty _archived_props[]; 71 static constexpr size_t num_archived_props(); 72 static ArchivedProperty& archived_prop(size_t i); 73 public: 74 #endif 75 76 // Provides the java.lang.Module for the unnamed module defined 77 // to the boot loader. 78 // 79 // IllegalArgumentExceptions are thrown for the following : 80 // * Module has a name 81 // * Module is not a subclass of java.lang.Module 82 // * Module's class loader is not the boot loader 83 // NullPointerExceptions are thrown if module is null. 84 static void set_bootloader_unnamed_module(Handle module, TRAPS); 85 86 // This either does a qualified export of package in module from_module to module 87 // to_module or, if to_module is null, does an unqualified export of package. 88 // Any "." in the package name will be converted to "/" 89 // 90 // Error conditions causing IlegalArgumentException to be throw : 91 // * Module from_module does not exist 92 // * Module to_module is not null and does not exist 93 // * Package is not syntactically correct 94 // * Package is not defined for from_module's class loader 95 // * Package is not in module from_module. 96 static void add_module_exports(Handle from_module, jstring package, Handle to_module, TRAPS); 97 98 // This does a qualified export of package in module from_module to module 99 // to_module. Any "." in the package name will be converted to "/" 100 // 101 // Error conditions causing IlegalArgumentException to be throw : 102 // * Module from_module does not exist 103 // * Module to_module does not exist 104 // * Package is not syntactically correct 105 // * Package is not defined for from_module's class loader 106 // * Package is not in module from_module. 107 static void add_module_exports_qualified(Handle from_module, jstring package, Handle to_module, TRAPS); 108 109 // add_reads_module adds module to_module to the list of modules that from_module 110 // can read. If from_module is the same as to_module then this is a no-op. 111 // If to_module is null then from_module is marked as a loose module (meaning that 112 // from_module can read all current and future unnamed modules). 113 // An IllegalArgumentException is thrown if from_module is null or either (non-null) 114 // module does not exist. 115 static void add_reads_module(Handle from_module, Handle to_module, TRAPS); 116 117 // Return the java.lang.Module object for this class object. 118 static jobject get_module(jclass clazz, TRAPS); 119 120 // Return the java.lang.Module object for this class loader and package. 121 // Returns null if the package name is empty, if the resulting package 122 // entry is null, if the module is not found or is unnamed. 123 // The package should contain /'s, not .'s, as in java/lang, not java.lang. 124 static oop get_named_module(Handle h_loader, const char* package); 125 126 // Marks the specified package as exported to all unnamed modules. 127 // If either module or package is null then NullPointerException is thrown. 128 // If module or package is bad, or module is unnamed, or package is not in 129 // module then IllegalArgumentException is thrown. 130 static void add_module_exports_to_all_unnamed(Handle module, jstring package, TRAPS); 131 132 // Return TRUE iff package is defined by loader 133 static bool is_package_defined(Symbol* package_name, Handle h_loader); 134 static ModuleEntryTable* get_module_entry_table(Handle h_loader); 135 }; 136 137 #endif // SHARE_CLASSFILE_MODULES_HPP