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