1 /*
2 * Copyright (c) 2015, 2018, 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/classFileStream.hpp"
28 #include "classfile/classListParser.hpp"
29 #include "classfile/classLoader.inline.hpp"
30 #include "classfile/classLoaderExt.hpp"
31 #include "classfile/classLoaderData.inline.hpp"
32 #include "classfile/klassFactory.hpp"
33 #include "classfile/modules.hpp"
34 #include "classfile/sharedClassUtil.hpp"
35 #include "classfile/sharedPathsMiscInfo.hpp"
36 #include "classfile/systemDictionaryShared.hpp"
37 #include "classfile/vmSymbols.hpp"
38 #include "memory/allocation.inline.hpp"
39 #include "memory/filemap.hpp"
40 #include "memory/resourceArea.hpp"
41 #include "oops/instanceKlass.hpp"
42 #include "oops/oop.inline.hpp"
43 #include "oops/symbol.hpp"
44 #include "runtime/arguments.hpp"
45 #include "runtime/handles.inline.hpp"
46 #include "runtime/java.hpp"
47 #include "runtime/javaCalls.hpp"
48 #include "runtime/os.hpp"
49 #include "services/threadService.hpp"
50 #include "utilities/stringUtils.hpp"
51
52 jshort ClassLoaderExt::_app_class_paths_start_index = ClassLoaderExt::max_classpath_index;
53 jshort ClassLoaderExt::_app_module_paths_start_index = ClassLoaderExt::max_classpath_index;
54 bool ClassLoaderExt::_has_app_classes = false;
55 bool ClassLoaderExt::_has_platform_classes = false;
56
57 void ClassLoaderExt::setup_app_search_path() {
58 assert(DumpSharedSpaces, "this function is only used with -Xshare:dump and -XX:+UseAppCDS");
59 _app_class_paths_start_index = ClassLoader::num_boot_classpath_entries();
60 char* app_class_path = os::strdup(Arguments::get_appclasspath());
61
62 if (strcmp(app_class_path, ".") == 0) {
63 // This doesn't make any sense, even for AppCDS, so let's skip it. We
64 // don't want to throw an error here because -cp "." is usually assigned
65 // by the launcher when classpath is not specified.
66 trace_class_path("app loader class path (skipped)=", app_class_path);
67 } else {
68 trace_class_path("app loader class path=", app_class_path);
69 shared_paths_misc_info()->add_app_classpath(app_class_path);
70 ClassLoader::setup_app_search_path(app_class_path);
71 }
72 }
73
74 void ClassLoaderExt::process_module_table(ModuleEntryTable* met, TRAPS) {
75 ResourceMark rm;
76 for (int i = 0; i < met->table_size(); i++) {
77 for (ModuleEntry* m = met->bucket(i); m != NULL;) {
78 char* path = m->location()->as_C_string();
79 if (strncmp(path, "file:", 5) == 0 && ClassLoader::string_ends_with(path, ".jar")) {
80 m->print();
81 path = ClassLoader::skip_uri_protocol(path);
82 ClassLoader::setup_module_search_path(path, THREAD);
83 }
84 m = m->next();
85 }
86 }
87 }
88 void ClassLoaderExt::setup_module_search_path(TRAPS) {
89 assert(DumpSharedSpaces, "this function is only used with -Xshare:dump and -XX:+UseAppCDS");
90 _app_module_paths_start_index = ClassLoader::num_boot_classpath_entries() +
91 ClassLoader::num_app_classpath_entries();
92 Handle system_class_loader (THREAD, SystemDictionary::java_system_loader());
93 ModuleEntryTable* met = Modules::get_module_entry_table(system_class_loader);
94 process_module_table(met, THREAD);
95 }
96
97 char* ClassLoaderExt::read_manifest(ClassPathEntry* entry, jint *manifest_size, bool clean_text, TRAPS) {
98 const char* name = "META-INF/MANIFEST.MF";
99 char* manifest;
100 jint size;
101
102 assert(entry->is_jar_file(), "must be");
103 manifest = (char*) ((ClassPathZipEntry*)entry )->open_entry(name, &size, true, CHECK_NULL);
104
105 if (manifest == NULL) { // No Manifest
106 *manifest_size = 0;
107 return NULL;
108 }
109
110
111 if (clean_text) {
112 // See http://docs.oracle.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Manifest
113 // (1): replace all CR/LF and CR with LF
114 StringUtils::replace_no_expand(manifest, "\r\n", "\n");
115
116 // (2) remove all new-line continuation (remove all "\n " substrings)
117 StringUtils::replace_no_expand(manifest, "\n ", "");
118 }
119
120 *manifest_size = (jint)strlen(manifest);
121 return manifest;
122 }
123
124 char* ClassLoaderExt::get_class_path_attr(const char* jar_path, char* manifest, jint manifest_size) {
125 const char* tag = "Class-Path: ";
126 const int tag_len = (int)strlen(tag);
127 char* found = NULL;
128 char* line_start = manifest;
129 char* end = manifest + manifest_size;
130
131 assert(*end == 0, "must be nul-terminated");
132
133 while (line_start < end) {
134 char* line_end = strchr(line_start, '\n');
135 if (line_end == NULL) {
136 // JAR spec require the manifest file to be terminated by a new line.
137 break;
138 }
139 if (strncmp(tag, line_start, tag_len) == 0) {
140 if (found != NULL) {
141 // Same behavior as jdk/src/share/classes/java/util/jar/Attributes.java
142 // If duplicated entries are found, the last one is used.
143 tty->print_cr("Warning: Duplicate name in Manifest: %s.\n"
144 "Ensure that the manifest does not have duplicate entries, and\n"
145 "that blank lines separate individual sections in both your\n"
146 "manifest and in the META-INF/MANIFEST.MF entry in the jar file:\n%s\n", tag, jar_path);
147 }
148 found = line_start + tag_len;
149 assert(found <= line_end, "sanity");
150 *line_end = '\0';
151 }
152 line_start = line_end + 1;
153 }
154 return found;
155 }
156
157 void ClassLoaderExt::process_jar_manifest(ClassPathEntry* entry,
158 bool check_for_duplicates) {
159 Thread* THREAD = Thread::current();
160 ResourceMark rm(THREAD);
161 jint manifest_size;
162 char* manifest = read_manifest(entry, &manifest_size, CHECK);
163
164 if (manifest == NULL) {
165 return;
166 }
167
168 if (strstr(manifest, "Extension-List:") != NULL) {
169 tty->print_cr("-Xshare:dump does not support Extension-List in JAR manifest: %s", entry->name());
170 vm_exit(1);
171 }
172
173 char* cp_attr = get_class_path_attr(entry->name(), manifest, manifest_size);
174
175 if (cp_attr != NULL && strlen(cp_attr) > 0) {
176 trace_class_path("found Class-Path: ", cp_attr);
177
178 char sep = os::file_separator()[0];
179 const char* dir_name = entry->name();
180 const char* dir_tail = strrchr(dir_name, sep);
181 int dir_len;
182 if (dir_tail == NULL) {
183 dir_len = 0;
184 } else {
185 dir_len = dir_tail - dir_name + 1;
186 }
187
188 // Split the cp_attr by spaces, and add each file
189 char* file_start = cp_attr;
190 char* end = file_start + strlen(file_start);
191
192 while (file_start < end) {
193 char* file_end = strchr(file_start, ' ');
194 if (file_end != NULL) {
195 *file_end = 0;
196 file_end += 1;
197 } else {
198 file_end = end;
199 }
200
201 int name_len = (int)strlen(file_start);
202 if (name_len > 0) {
203 ResourceMark rm(THREAD);
204 char* libname = NEW_RESOURCE_ARRAY(char, dir_len + name_len + 1);
205 *libname = 0;
206 strncat(libname, dir_name, dir_len);
207 strncat(libname, file_start, name_len);
208 trace_class_path("library = ", libname);
209 ClassLoader::update_class_path_entry_list(libname, true, false);
210 }
211
212 file_start = file_end;
213 }
214 }
215 }
216
217 void ClassLoaderExt::setup_search_paths() {
218 if (UseAppCDS) {
219 shared_paths_misc_info()->record_app_offset();
220 ClassLoaderExt::setup_app_search_path();
221 }
222 }
223
224 void ClassLoaderExt::setup_module_paths(TRAPS) {
225 if (UseAppCDS) {
226 ClassLoaderExt::setup_module_search_path(THREAD);
227 }
228 }
229
230 Thread* ClassLoaderExt::Context::_dump_thread = NULL;
231
232 void ClassLoaderExt::record_result(ClassLoaderExt::Context *context,
233 Symbol* class_name,
234 const s2 classpath_index,
235 InstanceKlass* result,
236 TRAPS) {
237 assert(DumpSharedSpaces, "Sanity");
238
239 // We need to remember where the class comes from during dumping.
240 oop loader = result->class_loader();
241 s2 classloader_type = ClassLoader::BOOT_LOADER;
242 if (SystemDictionary::is_system_class_loader(loader)) {
243 classloader_type = ClassLoader::APP_LOADER;
244 ClassLoaderExt::set_has_app_classes();
245 } else if (SystemDictionary::is_platform_class_loader(loader)) {
246 classloader_type = ClassLoader::PLATFORM_LOADER;
247 ClassLoaderExt::set_has_platform_classes();
248 }
249 result->set_shared_classpath_index(classpath_index);
250 result->set_class_loader_type(classloader_type);
251 }
252
253 void ClassLoaderExt::finalize_shared_paths_misc_info() {
254 if (UseAppCDS) {
255 if (!_has_app_classes) {
256 shared_paths_misc_info()->pop_app();
257 }
258 }
259 }
260
261 // Load the class of the given name from the location given by path. The path is specified by
262 // the "source:" in the class list file (see classListParser.cpp), and can be a directory or
263 // a JAR file.
264 InstanceKlass* ClassLoaderExt::load_class(Symbol* name, const char* path, TRAPS) {
265
266 assert(name != NULL, "invariant");
267 assert(DumpSharedSpaces && UseAppCDS, "this function is only used with -Xshare:dump and -XX:+UseAppCDS");
268 ResourceMark rm(THREAD);
269 const char* class_name = name->as_C_string();
270
271 const char* file_name = file_name_for_class_name(class_name,
272 name->utf8_length());
273 assert(file_name != NULL, "invariant");
274
275 // Lookup stream for parsing .class file
276 ClassFileStream* stream = NULL;
277 ClassPathEntry* e = find_classpath_entry_from_cache(path, CHECK_NULL);
278 if (e == NULL) {
279 return NULL;
280 }
281 {
282 PerfClassTraceTime vmtimer(perf_sys_class_lookup_time(),
283 ((JavaThread*) THREAD)->get_thread_stat()->perf_timers_addr(),
284 PerfClassTraceTime::CLASS_LOAD);
285 stream = e->open_stream(file_name, CHECK_NULL);
286 }
287
288 if (NULL == stream) {
289 tty->print_cr("Preload Warning: Cannot find %s", class_name);
290 return NULL;
291 }
292
293 assert(stream != NULL, "invariant");
294 stream->set_verify(true);
295
296 ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();
297 Handle protection_domain;
298
299 InstanceKlass* result = KlassFactory::create_from_stream(stream,
300 name,
301 loader_data,
302 protection_domain,
303 NULL, // host_klass
304 NULL, // cp_patches
305 THREAD);
306
307 if (HAS_PENDING_EXCEPTION) {
308 tty->print_cr("Preload Error: Failed to load %s", class_name);
309 return NULL;
310 }
311 result->set_shared_classpath_index(UNREGISTERED_INDEX);
312 SystemDictionaryShared::set_shared_class_misc_info(result, stream);
313 return result;
314 }
315
316 struct CachedClassPathEntry {
317 const char* _path;
318 ClassPathEntry* _entry;
319 };
320
321 static GrowableArray<CachedClassPathEntry>* cached_path_entries = NULL;
322
323 ClassPathEntry* ClassLoaderExt::find_classpath_entry_from_cache(const char* path, TRAPS) {
324 // This is called from dump time so it's single threaded and there's no need for a lock.
325 assert(DumpSharedSpaces && UseAppCDS, "this function is only used with -Xshare:dump and -XX:+UseAppCDS");
326 if (cached_path_entries == NULL) {
327 cached_path_entries = new (ResourceObj::C_HEAP, mtClass) GrowableArray<CachedClassPathEntry>(20, /*c heap*/ true);
328 }
329 CachedClassPathEntry ccpe;
330 for (int i=0; i<cached_path_entries->length(); i++) {
331 ccpe = cached_path_entries->at(i);
332 if (strcmp(ccpe._path, path) == 0) {
333 if (i != 0) {
334 // Put recent entries at the beginning to speed up searches.
335 cached_path_entries->remove_at(i);
336 cached_path_entries->insert_before(0, ccpe);
337 }
338 return ccpe._entry;
339 }
340 }
341
342 struct stat st;
343 if (os::stat(path, &st) != 0) {
344 // File or directory not found
345 return NULL;
346 }
347 ClassPathEntry* new_entry = NULL;
348
349 new_entry = create_class_path_entry(path, &st, false, false, CHECK_NULL);
350 if (new_entry == NULL) {
351 return NULL;
352 }
353 ccpe._path = strdup(path);
354 ccpe._entry = new_entry;
355 cached_path_entries->insert_before(0, ccpe);
356 return new_entry;
357 }
358
359 Klass* ClassLoaderExt::load_one_class(ClassListParser* parser, TRAPS) {
360 return parser->load_current_class(THREAD);
361 }