1 /*
2 * Copyright (c) 2014, 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/classLoader.hpp"
27 #include "classfile/sharedPathsMiscInfo.hpp"
28 #include "logging/log.hpp"
29 #include "logging/logStream.hpp"
30 #include "memory/allocation.inline.hpp"
31 #include "memory/filemap.hpp"
32 #include "memory/metaspaceShared.hpp"
33 #include "memory/resourceArea.hpp"
34 #include "runtime/arguments.hpp"
35 #include "runtime/os.inline.hpp"
36 #include "utilities/ostream.hpp"
37
38 SharedPathsMiscInfo::SharedPathsMiscInfo() {
39 _app_offset = 0;
40 _buf_size = INITIAL_BUF_SIZE;
41 _cur_ptr = _buf_start = NEW_C_HEAP_ARRAY(char, _buf_size, mtClass);
42 _allocated = true;
43 }
44
45 SharedPathsMiscInfo::~SharedPathsMiscInfo() {
46 if (_allocated) {
47 FREE_C_HEAP_ARRAY(char, _buf_start);
48 }
49 }
50
51 void SharedPathsMiscInfo::add_path(const char* path, int type) {
52 log_info(class, path)("type=%s ", type_name(type));
53 ClassLoader::trace_class_path("add misc shared path ", path);
54 write(path, strlen(path) + 1);
55 write_jint(jint(type));
56 }
57
58 void SharedPathsMiscInfo::ensure_size(size_t needed_bytes) {
59 assert(_allocated, "cannot modify buffer during validation.");
60 int used = get_used_bytes();
61 int target = used + int(needed_bytes);
62 if (target > _buf_size) {
63 _buf_size = _buf_size * 2 + (int)needed_bytes;
64 _buf_start = REALLOC_C_HEAP_ARRAY(char, _buf_start, _buf_size, mtClass);
65 _cur_ptr = _buf_start + used;
66 _end_ptr = _buf_start + _buf_size;
67 }
68 }
69
70 void SharedPathsMiscInfo::write(const void* ptr, size_t size) {
71 ensure_size(size);
72 memcpy(_cur_ptr, ptr, size);
73 _cur_ptr += size;
74 }
75
76 bool SharedPathsMiscInfo::read(void* ptr, size_t size) {
77 if (_cur_ptr + size <= _end_ptr) {
78 memcpy(ptr, _cur_ptr, size);
79 _cur_ptr += size;
80 return true;
81 }
82 return false;
83 }
84
85 bool SharedPathsMiscInfo::fail(const char* msg, const char* name) {
86 ClassLoader::trace_class_path(msg, name);
87 MetaspaceShared::set_archive_loading_failed();
88 return false;
89 }
90
91 void SharedPathsMiscInfo::print_path(outputStream* out, int type, const char* path) {
92 switch (type) {
93 case BOOT_PATH:
94 out->print("Expecting BOOT path=%s", path);
95 break;
96 case NON_EXIST:
97 out->print("Expecting that %s does not exist", path);
98 break;
99 case APP_PATH:
100 ClassLoader::trace_class_path("Expecting -Djava.class.path=", path);
101 break;
102 default:
103 ShouldNotReachHere();
104 }
105 }
106
107 bool SharedPathsMiscInfo::check() {
108 // The whole buffer must be 0 terminated so that we can use strlen and strcmp
109 // without fear.
110 _end_ptr -= sizeof(jint);
111 if (_cur_ptr >= _end_ptr) {
112 return fail("Truncated archive file header");
113 }
114 if (*_end_ptr != 0) {
115 return fail("Corrupted archive file header");
116 }
117
118 while (_cur_ptr < _end_ptr) {
119 jint type;
120 const char* path = _cur_ptr;
121 _cur_ptr += strlen(path) + 1;
122 if (!read_jint(&type)) {
123 return fail("Corrupted archive file header");
124 }
125 LogTarget(Info, class, path) lt;
126 if (lt.is_enabled()) {
127 lt.print("type=%s ", type_name(type));
128 LogStream ls(lt);
129 print_path(&ls, type, path);
130 ls.cr();
131 }
132 if (!check(type, path)) {
133 if (!PrintSharedArchiveAndExit) {
134 return false;
135 }
136 } else {
137 ClassLoader::trace_class_path("ok");
138 }
139 }
140
141 return true;
142 }
143
144 char* skip_first_path_entry(const char* path) {
145 size_t path_sep_len = strlen(os::path_separator());
146 char* p = strstr((char*)path, os::path_separator());
147 if (p != NULL) {
148 debug_only( {
149 size_t image_name_len = strlen(MODULES_IMAGE_NAME);
150 assert(strncmp(p - image_name_len, MODULES_IMAGE_NAME, image_name_len) == 0,
151 "first entry must be the modules image");
152 } );
153 p += path_sep_len;
154 } else {
155 debug_only( {
156 assert(ClassLoader::string_ends_with(path, MODULES_IMAGE_NAME),
157 "first entry must be the modules image");
158 } );
159 }
160 return p;
161 }
162
163 bool SharedPathsMiscInfo::check(jint type, const char* path) {
164 assert(UseSharedSpaces, "runtime only");
165 switch (type) {
166 case BOOT_PATH:
167 {
168 //
169 // - Archive contains boot classes only - relaxed boot path check:
170 // Extra path elements appended to the boot path at runtime are allowed.
171 //
172 // - Archive contains application or platform classes - strict boot path check:
173 // Validate the entire runtime boot path, which must be compactible
174 // with the dump time boot path. Appending boot path at runtime is not
175 // allowed.
176 //
177
178 // The first entry in boot path is the modules_image (guaranteed by
179 // ClassLoader::setup_boot_search_path()). Skip the first entry. The
180 // path of the runtime modules_image may be different from the dump
181 // time path (e.g. the JDK image is copied to a different location
182 // after generating the shared archive), which is acceptable. For most
183 // common cases, the dump time boot path might contain modules_image only.
184 char* runtime_boot_path = Arguments::get_sysclasspath();
185 char* rp = skip_first_path_entry(runtime_boot_path);
186 char* dp = skip_first_path_entry(path);
187
188 bool relaxed_check = !FileMapInfo::current_info()->header()->has_platform_or_app_classes();
189 if (dp == NULL && rp == NULL) {
190 break; // ok, both runtime and dump time boot paths have modules_images only
191 } else if (dp == NULL && rp != NULL && relaxed_check) {
192 break; // ok, relaxed check, runtime has extra boot append path entries
193 } else if (dp != NULL && rp != NULL) {
194 size_t num;
195 size_t dp_len = strlen(dp);
196 size_t rp_len = strlen(rp);
197 if (rp_len >= dp_len) {
198 if (relaxed_check) {
199 // only check the leading entries in the runtime boot path, up to
200 // the length of the dump time boot path
201 num = dp_len;
202 } else {
203 // check the full runtime boot path, must match with dump time
204 num = rp_len;
205 }
206
207 if (os::file_name_strncmp(dp, rp, num) == 0) {
208 // make sure it is the end of an entry in the runtime boot path
209 if (rp[dp_len] == '\0' || rp[dp_len] == os::path_separator()[0]) {
210 break; // ok, runtime and dump time paths match
211 }
212 }
213 }
214 }
215
216 // The paths are different
217 return fail("[BOOT classpath mismatch, actual =", runtime_boot_path);
218 }
219 break;
220 case NON_EXIST:
221 {
222 struct stat st;
223 if (os::stat(path, &st) == 0) {
224 // The file actually exists
225 // But we want it to not exist -> fail
226 return fail("File must not exist");
227 }
228 }
229 break;
230 case APP_PATH:
231 {
232 size_t len = strlen(path);
233 const char *appcp = Arguments::get_appclasspath();
234 assert(appcp != NULL, "NULL app classpath");
235 size_t appcp_len = strlen(appcp);
236 if (appcp_len < len) {
237 return fail("Run time APP classpath is shorter than the one at dump time: ", appcp);
238 }
239 // Prefix is OK: E.g., dump with -cp foo.jar, but run with -cp foo.jar:bar.jar.
240 if (os::file_name_strncmp(path, appcp, len) != 0) {
241 return fail("[APP classpath mismatch, actual: -Djava.class.path=", appcp);
242 }
243 if (appcp[len] != '\0' && appcp[len] != os::path_separator()[0]) {
244 return fail("Dump time APP classpath is not a proper prefix of run time APP classpath: ", appcp);
245 }
246 }
247 break;
248 default:
249 return fail("Corrupted archive file header");
250 }
251
252 return true;
253 }