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 #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 Symbol;
33
34 class Modules : AllStatic {
35 static void check_cds_restrictions(TRAPS) NOT_CDS_JAVA_HEAP_RETURN;
36
37 public:
38 // define_module defines a module containing the specified packages. It binds the
39 // module to its class loader by creating the ModuleEntry record in the
40 // ClassLoader's ModuleEntry table, and creates PackageEntry records in the class
41 // loader's PackageEntry table. The jstring for all package names will convert "."
42 // to "/"
43 //
44 // IllegalArgumentExceptions are thrown for the following :
45 // * Module's Class loader is not a subclass of java.lang.ClassLoader
46 // * Module's Class loader already has a module with that name
47 // * Module's Class loader has already defined types for any of the module's packages
48 // * Module_name is syntactically bad
49 // * Packages contains an illegal package name or a non-String object
50 // * A package already exists in another module for this class loader
51 // * Module is an unnamed module
52 // NullPointerExceptions are thrown if module is null.
53 static void define_module(Handle module, jboolean is_open, jstring version,
54 jstring location, jobjectArray packages, TRAPS);
55
56 static bool check_archived_module_oop(oop orig_module_obj) NOT_CDS_JAVA_HEAP_RETURN_(false);
57 static void update_oops_in_archived_module(oop orig_module_obj, int archived_module_root_index)
58 NOT_CDS_JAVA_HEAP_RETURN;
59 static void define_archived_modules(Handle h_platform_loader, Handle h_system_loader,
60 TRAPS) NOT_CDS_JAVA_HEAP_RETURN;
61 static void verify_archived_modules() NOT_CDS_JAVA_HEAP_RETURN;
62 static void dump_archived_module_info() NOT_CDS_JAVA_HEAP_RETURN;
63 static void serialize_archived_module_info(SerializeClosure* soc) NOT_CDS_JAVA_HEAP_RETURN;
64 static void dump_main_module_name() NOT_CDS_JAVA_HEAP_RETURN;
65 static void serialize(SerializeClosure* soc) NOT_CDS_JAVA_HEAP_RETURN;
66 static void check_archived_flag_consistency(char* archived_flag, const char* runtime_flag, const char* property) NOT_CDS_JAVA_HEAP_RETURN;
67
68 static void dump_native_access_flag() NOT_CDS_JAVA_HEAP_RETURN;
69 static const char* get_native_access_flags_as_sorted_string() NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
70 static void serialize_native_access_flags(SerializeClosure* soc) NOT_CDS_JAVA_HEAP_RETURN;
71
72 static void dump_addmods_names() NOT_CDS_JAVA_HEAP_RETURN;
73 static const char* get_addmods_names_as_sorted_string() NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
74 static void serialize_addmods_names(SerializeClosure* soc) NOT_CDS_JAVA_HEAP_RETURN;
75
76 static const char* get_numbered_property_as_sorted_string(const char* property) NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
77 #if INCLUDE_CDS_JAVA_HEAP
78 static char* _archived_main_module_name;
79 static char* _archived_addmods_names;
80 static char* _archived_native_access_flags;
81 #endif
82
83 // Provides the java.lang.Module for the unnamed module defined
84 // to the boot loader.
85 //
86 // IllegalArgumentExceptions are thrown for the following :
87 // * Module has a name
88 // * Module is not a subclass of java.lang.Module
89 // * Module's class loader is not the boot loader
90 // NullPointerExceptions are thrown if module is null.
91 static void set_bootloader_unnamed_module(Handle module, TRAPS);
92
93 // This either does a qualified export of package in module from_module to module
94 // to_module or, if to_module is null, does an unqualified export of package.
95 // Any "." in the package name will be converted to "/"
96 //
97 // Error conditions causing IlegalArgumentException to be throw :
98 // * Module from_module does not exist
99 // * Module to_module is not null and does not exist
100 // * Package is not syntactically correct
101 // * Package is not defined for from_module's class loader
102 // * Package is not in module from_module.
103 static void add_module_exports(Handle from_module, jstring package, Handle to_module, TRAPS);
104
105 // This does a qualified export of package in module from_module to module
106 // to_module. Any "." in the package name will be converted to "/"
107 //
108 // Error conditions causing IlegalArgumentException to be throw :
109 // * Module from_module does not exist
110 // * Module to_module does not exist
111 // * Package is not syntactically correct
112 // * Package is not defined for from_module's class loader
113 // * Package is not in module from_module.
114 static void add_module_exports_qualified(Handle from_module, jstring package, Handle to_module, TRAPS);
115
116 // add_reads_module adds module to_module to the list of modules that from_module
117 // can read. If from_module is the same as to_module then this is a no-op.
118 // If to_module is null then from_module is marked as a loose module (meaning that
119 // from_module can read all current and future unnamed modules).
120 // An IllegalArgumentException is thrown if from_module is null or either (non-null)
121 // module does not exist.
122 static void add_reads_module(Handle from_module, Handle to_module, TRAPS);
123
124 // Return the java.lang.Module object for this class object.
125 static jobject get_module(jclass clazz, TRAPS);
126
127 // Return the java.lang.Module object for this class loader and package.
128 // Returns null if the package name is empty, if the resulting package
129 // entry is null, if the module is not found or is unnamed.
130 // The package should contain /'s, not .'s, as in java/lang, not java.lang.
131 static oop get_named_module(Handle h_loader, const char* package);
132
133 // Marks the specified package as exported to all unnamed modules.
134 // If either module or package is null then NullPointerException is thrown.
135 // If module or package is bad, or module is unnamed, or package is not in
136 // module then IllegalArgumentException is thrown.
137 static void add_module_exports_to_all_unnamed(Handle module, jstring package, TRAPS);
138
139 // Return TRUE iff package is defined by loader
140 static bool is_package_defined(Symbol* package_name, Handle h_loader);
141 static ModuleEntryTable* get_module_entry_table(Handle h_loader);
142 };
143
144 #endif // SHARE_CLASSFILE_MODULES_HPP