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