1 /*
2 * Copyright (c) 2015, 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/cds_globals.hpp"
27 #include "cds/cdsConfig.hpp"
28 #include "cds/dynamicArchive.hpp"
29 #include "cds/filemap.hpp"
30 #include "cds/heapShared.hpp"
31 #include "classfile/classFileParser.hpp"
32 #include "classfile/classLoader.inline.hpp"
33 #include "classfile/classLoaderExt.hpp"
34 #include "classfile/classLoaderData.inline.hpp"
35 #include "classfile/classLoadInfo.hpp"
36 #include "classfile/klassFactory.hpp"
37 #include "classfile/modules.hpp"
38 #include "classfile/systemDictionary.hpp"
39 #include "classfile/vmSymbols.hpp"
40 #include "gc/shared/collectedHeap.hpp"
41 #include "logging/log.hpp"
42 #include "memory/allocation.inline.hpp"
43 #include "memory/resourceArea.hpp"
44 #include "oops/instanceKlass.hpp"
45 #include "oops/klass.inline.hpp"
46 #include "oops/oop.inline.hpp"
47 #include "oops/symbol.hpp"
48 #include "runtime/arguments.hpp"
49 #include "runtime/handles.inline.hpp"
50 #include "runtime/java.hpp"
51 #include "runtime/os.hpp"
52 #include "utilities/checkedCast.hpp"
53 #include "utilities/stringUtils.hpp"
54
55 jshort ClassLoaderExt::_app_class_paths_start_index = ClassLoaderExt::max_classpath_index;
56 jshort ClassLoaderExt::_app_module_paths_start_index = ClassLoaderExt::max_classpath_index;
57 jshort ClassLoaderExt::_max_used_path_index = 0;
58 int ClassLoaderExt::_num_module_paths = 0;
59 bool ClassLoaderExt::_has_app_classes = false;
60 bool ClassLoaderExt::_has_platform_classes = false;
61 bool ClassLoaderExt::_has_non_jar_in_classpath = false;
62
63 void ClassLoaderExt::append_boot_classpath(ClassPathEntry* new_entry) {
64 if (CDSConfig::is_using_archive()) {
65 warning("Sharing is only supported for boot loader classes because bootstrap classpath has been appended");
66 FileMapInfo::current_info()->set_has_platform_or_app_classes(false);
67 if (DynamicArchive::is_mapped()) {
68 FileMapInfo::dynamic_info()->set_has_platform_or_app_classes(false);
69 }
70 }
71 ClassLoader::add_to_boot_append_entries(new_entry);
72 }
73
74 void ClassLoaderExt::setup_app_search_path(JavaThread* current) {
75 assert(CDSConfig::is_dumping_archive(), "sanity");
76 int start_index = ClassLoader::num_boot_classpath_entries();
77 _app_class_paths_start_index = checked_cast<jshort>(start_index);
78 char* app_class_path = os::strdup_check_oom(Arguments::get_appclasspath(), mtClass);
79
80 if (strcmp(app_class_path, ".") == 0) {
81 // This doesn't make any sense, even for AppCDS, so let's skip it. We
82 // don't want to throw an error here because -cp "." is usually assigned
83 // by the launcher when classpath is not specified.
84 trace_class_path("app loader class path (skipped)=", app_class_path);
85 } else {
86 trace_class_path("app loader class path=", app_class_path);
87 ClassLoader::setup_app_search_path(current, app_class_path);
88 }
89
90 os::free(app_class_path);
91 }
92
93 int ClassLoaderExt::compare_module_names(const char** p1, const char** p2) {
94 return strcmp(*p1, *p2);
95 }
96
97 void ClassLoaderExt::process_module_table(JavaThread* current, ModuleEntryTable* met) {
98 ResourceMark rm(current);
99 GrowableArray<const char*>* module_paths = new GrowableArray<const char*>(5);
100
101 class ModulePathsGatherer : public ModuleClosure {
102 JavaThread* _current;
103 GrowableArray<const char*>* _module_paths;
104 public:
105 ModulePathsGatherer(JavaThread* current, GrowableArray<const char*>* module_paths) :
106 _current(current), _module_paths(module_paths) {}
107 void do_module(ModuleEntry* m) {
108 char* uri = m->location()->as_C_string();
109 if (strncmp(uri, "file:", 5) == 0) {
110 char* path = ClassLoader::uri_to_path(uri);
111 extract_jar_files_from_path(path, _module_paths);
112 }
113 }
114 };
115
116 ModulePathsGatherer gatherer(current, module_paths);
117 {
118 MutexLocker ml(Module_lock);
119 met->modules_do(&gatherer);
120 }
121
122 // Sort the module paths before storing into CDS archive for simpler
123 // checking at runtime.
124 module_paths->sort(compare_module_names);
125
126 for (int i = 0; i < module_paths->length(); i++) {
127 ClassLoader::setup_module_search_path(current, module_paths->at(i));
128 }
129 }
130
131 void ClassLoaderExt::setup_module_paths(JavaThread* current) {
132 assert(CDSConfig::is_dumping_archive(), "sanity");
133 int start_index = ClassLoader::num_boot_classpath_entries() +
134 ClassLoader::num_app_classpath_entries();
135 _app_module_paths_start_index = checked_cast<jshort>(start_index);
136 Handle system_class_loader (current, SystemDictionary::java_system_loader());
137 ModuleEntryTable* met = Modules::get_module_entry_table(system_class_loader);
138 process_module_table(current, met);
139 }
140
141 bool ClassLoaderExt::has_jar_suffix(const char* filename) {
142 // In jdk.internal.module.ModulePath.readModule(), it checks for the ".jar" suffix.
143 // Performing the same check here.
144 const char* dot = strrchr(filename, '.');
145 if (dot != nullptr && strcmp(dot + 1, "jar") == 0) {
146 return true;
147 }
148 return false;
149 }
150
151 void ClassLoaderExt::extract_jar_files_from_path(const char* path, GrowableArray<const char*>* module_paths) {
152 DIR* dirp = os::opendir(path);
153 if (dirp == nullptr && errno == ENOTDIR && has_jar_suffix(path)) {
154 module_paths->append(path);
155 } else {
156 if (dirp != nullptr) {
157 struct dirent* dentry;
158 while ((dentry = os::readdir(dirp)) != nullptr) {
159 const char* file_name = dentry->d_name;
160 if (has_jar_suffix(file_name)) {
161 size_t full_name_len = strlen(path) + strlen(file_name) + strlen(os::file_separator()) + 1;
162 char* full_name = NEW_RESOURCE_ARRAY(char, full_name_len);
163 int n = os::snprintf(full_name, full_name_len, "%s%s%s", path, os::file_separator(), file_name);
164 assert((size_t)n == full_name_len - 1, "Unexpected number of characters in string");
165 module_paths->append(full_name);
166 }
167 }
168 os::closedir(dirp);
169 }
170 }
171 }
172
173 char* ClassLoaderExt::read_manifest(JavaThread* current, ClassPathEntry* entry,
174 jint *manifest_size, bool clean_text) {
175 const char* name = "META-INF/MANIFEST.MF";
176 char* manifest;
177 jint size;
178
179 assert(entry->is_jar_file(), "must be");
180 manifest = (char*) ((ClassPathZipEntry*)entry )->open_entry(current, name, &size, true);
181
182 if (manifest == nullptr) { // No Manifest
183 *manifest_size = 0;
184 return nullptr;
185 }
186
187
188 if (clean_text) {
189 // See http://docs.oracle.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Manifest
190 // (1): replace all CR/LF and CR with LF
191 StringUtils::replace_no_expand(manifest, "\r\n", "\n");
192
193 // (2) remove all new-line continuation (remove all "\n " substrings)
194 StringUtils::replace_no_expand(manifest, "\n ", "");
195 }
196
197 *manifest_size = (jint)strlen(manifest);
198 return manifest;
199 }
200
201 char* ClassLoaderExt::get_class_path_attr(const char* jar_path, char* manifest, jint manifest_size) {
202 const char* tag = "Class-Path: ";
203 const int tag_len = (int)strlen(tag);
204 char* found = nullptr;
205 char* line_start = manifest;
206 char* end = manifest + manifest_size;
207
208 assert(*end == 0, "must be nul-terminated");
209
210 while (line_start < end) {
211 char* line_end = strchr(line_start, '\n');
212 if (line_end == nullptr) {
213 // JAR spec require the manifest file to be terminated by a new line.
214 break;
215 }
216 if (strncmp(tag, line_start, tag_len) == 0) {
217 if (found != nullptr) {
218 // Same behavior as jdk/src/share/classes/java/util/jar/Attributes.java
219 // If duplicated entries are found, the last one is used.
220 log_warning(cds)("Warning: Duplicate name in Manifest: %s.\n"
221 "Ensure that the manifest does not have duplicate entries, and\n"
222 "that blank lines separate individual sections in both your\n"
223 "manifest and in the META-INF/MANIFEST.MF entry in the jar file:\n%s\n", tag, jar_path);
224 }
225 found = line_start + tag_len;
226 assert(found <= line_end, "sanity");
227 *line_end = '\0';
228 }
229 line_start = line_end + 1;
230 }
231 return found;
232 }
233
234 void ClassLoaderExt::process_jar_manifest(JavaThread* current, ClassPathEntry* entry) {
235 ResourceMark rm(current);
236 jint manifest_size;
237 char* manifest = read_manifest(current, entry, &manifest_size);
238
239 if (manifest == nullptr) {
240 return;
241 }
242
243 if (strstr(manifest, "Extension-List:") != nullptr) {
244 vm_exit_during_cds_dumping(err_msg("-Xshare:dump does not support Extension-List in JAR manifest: %s", entry->name()));
245 }
246
247 char* cp_attr = get_class_path_attr(entry->name(), manifest, manifest_size);
248
249 if (cp_attr != nullptr && strlen(cp_attr) > 0) {
250 trace_class_path("found Class-Path: ", cp_attr);
251
252 char sep = os::file_separator()[0];
253 const char* dir_name = entry->name();
254 const char* dir_tail = strrchr(dir_name, sep);
255 #ifdef _WINDOWS
256 // On Windows, we also support forward slash as the file separator when locating entries in the classpath entry.
257 const char* dir_tail2 = strrchr(dir_name, '/');
258 if (dir_tail == nullptr) {
259 dir_tail = dir_tail2;
260 } else if (dir_tail2 != nullptr && dir_tail2 > dir_tail) {
261 dir_tail = dir_tail2;
262 }
263 #endif
264 int dir_len;
265 if (dir_tail == nullptr) {
266 dir_len = 0;
267 } else {
268 dir_len = pointer_delta_as_int(dir_tail, dir_name) + 1;
269 }
270
271 // Split the cp_attr by spaces, and add each file
272 char* file_start = cp_attr;
273 char* end = file_start + strlen(file_start);
274
275 while (file_start < end) {
276 char* file_end = strchr(file_start, ' ');
277 if (file_end != nullptr) {
278 *file_end = 0;
279 file_end += 1;
280 } else {
281 file_end = end;
282 }
283
284 size_t name_len = strlen(file_start);
285 if (name_len > 0) {
286 ResourceMark rm(current);
287 size_t libname_len = dir_len + name_len;
288 char* libname = NEW_RESOURCE_ARRAY(char, libname_len + 1);
289 int n = os::snprintf(libname, libname_len + 1, "%.*s%s", dir_len, dir_name, file_start);
290 assert((size_t)n == libname_len, "Unexpected number of characters in string");
291 if (ClassLoader::update_class_path_entry_list(current, libname, true, false, true /* from_class_path_attr */)) {
292 trace_class_path("library = ", libname);
293 } else {
294 trace_class_path("library (non-existent) = ", libname);
295 FileMapInfo::record_non_existent_class_path_entry(libname);
296 }
297 }
298
299 file_start = file_end;
300 }
301 }
302 }
303
304 void ClassLoaderExt::setup_search_paths(JavaThread* current) {
305 ClassLoaderExt::setup_app_search_path(current);
306 }
307
308 void ClassLoaderExt::record_result(const s2 classpath_index, InstanceKlass* result, bool redefined) {
309 assert(CDSConfig::is_dumping_archive(), "sanity");
310
311 // We need to remember where the class comes from during dumping.
312 oop loader = result->class_loader();
313 s2 classloader_type = ClassLoader::BOOT_LOADER;
314 if (SystemDictionary::is_system_class_loader(loader)) {
315 classloader_type = ClassLoader::APP_LOADER;
316 ClassLoaderExt::set_has_app_classes();
317 } else if (SystemDictionary::is_platform_class_loader(loader)) {
318 classloader_type = ClassLoader::PLATFORM_LOADER;
319 ClassLoaderExt::set_has_platform_classes();
320 }
321 if (classpath_index > ClassLoaderExt::max_used_path_index()) {
322 ClassLoaderExt::set_max_used_path_index(classpath_index);
323 }
324 result->set_shared_classpath_index(classpath_index);
325 result->set_shared_class_loader_type(classloader_type);
326 #if INCLUDE_CDS_JAVA_HEAP
327 if (CDSConfig::is_dumping_heap() && AllowArchivingWithJavaAgent && classloader_type == ClassLoader::BOOT_LOADER &&
328 classpath_index < 0 && redefined) {
329 // When dumping the heap (which happens only during static dump), classes for the built-in
330 // loaders are always loaded from known locations (jimage, classpath or modulepath),
331 // so classpath_index should always be >= 0.
332 // The only exception is when a java agent is used during dump time (for testing
333 // purposes only). If a class is transformed by the agent, the CodeSource of
334 // this class may point to an unknown location. This may break heap object archiving,
335 // which requires all the boot classes to be from known locations. This is an
336 // uncommon scenario (even in test cases). Let's simply disable heap object archiving.
337 ResourceMark rm;
338 log_warning(cds)("CDS heap objects cannot be written because class %s maybe modified by ClassFileLoadHook.",
339 result->external_name());
340 HeapShared::disable_writing();
341 }
342 #endif // INCLUDE_CDS_JAVA_HEAP
343 }