1 /*
2 * Copyright (c) 2003, 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/archiveBuilder.hpp"
27 #include "cds/archiveHeapLoader.inline.hpp"
28 #include "cds/archiveHeapWriter.hpp"
29 #include "cds/archiveUtils.inline.hpp"
30 #include "cds/cds_globals.hpp"
31 #include "cds/cdsConfig.hpp"
32 #include "cds/dynamicArchive.hpp"
33 #include "cds/filemap.hpp"
34 #include "cds/heapShared.hpp"
35 #include "cds/metaspaceShared.hpp"
36 #include "classfile/altHashing.hpp"
37 #include "classfile/classFileStream.hpp"
38 #include "classfile/classLoader.hpp"
39 #include "classfile/classLoader.inline.hpp"
40 #include "classfile/classLoaderData.inline.hpp"
41 #include "classfile/classLoaderExt.hpp"
42 #include "classfile/symbolTable.hpp"
43 #include "classfile/systemDictionaryShared.hpp"
44 #include "classfile/vmClasses.hpp"
45 #include "classfile/vmSymbols.hpp"
46 #include "jvm.h"
47 #include "logging/log.hpp"
48 #include "logging/logMessage.hpp"
49 #include "logging/logStream.hpp"
50 #include "memory/iterator.inline.hpp"
51 #include "memory/metadataFactory.hpp"
52 #include "memory/metaspaceClosure.hpp"
53 #include "memory/oopFactory.hpp"
54 #include "memory/universe.hpp"
55 #include "nmt/memTracker.hpp"
56 #include "oops/compressedOops.hpp"
57 #include "oops/compressedOops.inline.hpp"
58 #include "oops/objArrayOop.hpp"
59 #include "oops/oop.inline.hpp"
60 #include "prims/jvmtiExport.hpp"
61 #include "runtime/arguments.hpp"
62 #include "runtime/globals_extension.hpp"
63 #include "runtime/java.hpp"
64 #include "runtime/mutexLocker.hpp"
65 #include "runtime/os.hpp"
66 #include "runtime/vm_version.hpp"
67 #include "utilities/align.hpp"
68 #include "utilities/bitMap.inline.hpp"
69 #include "utilities/classpathStream.hpp"
70 #include "utilities/defaultStream.hpp"
71 #include "utilities/ostream.hpp"
72 #if INCLUDE_G1GC
73 #include "gc/g1/g1CollectedHeap.hpp"
74 #include "gc/g1/heapRegion.hpp"
75 #endif
76
77 # include <sys/stat.h>
78 # include <errno.h>
79
80 #ifndef O_BINARY // if defined (Win32) use binary files.
81 #define O_BINARY 0 // otherwise do nothing.
82 #endif
83
84 inline void CDSMustMatchFlags::do_print(outputStream* st, bool v) {
85 st->print("%s", v ? "true" : "false");
86 }
87
88 inline void CDSMustMatchFlags::do_print(outputStream* st, intx v) {
89 st->print(INTX_FORMAT, v);
90 }
91
92 inline void CDSMustMatchFlags::do_print(outputStream* st, uintx v) {
93 st->print(UINTX_FORMAT, v);
94 }
95
96 inline void CDSMustMatchFlags::do_print(outputStream* st, double v) {
97 st->print("%f", v);
98 }
99
100 void CDSMustMatchFlags::init() {
101 assert(CDSConfig::is_dumping_archive(), "sanity");
102 _max_name_width = 0;
103
104 #define INIT_CDS_MUST_MATCH_FLAG(n) \
105 _v_##n = n; \
106 _max_name_width = MAX2(_max_name_width,strlen(#n));
107 CDS_MUST_MATCH_FLAGS_DO(INIT_CDS_MUST_MATCH_FLAG);
108 #undef INIT_CDS_MUST_MATCH_FLAG
109 }
110
111 bool CDSMustMatchFlags::runtime_check() const {
112 #define CHECK_CDS_MUST_MATCH_FLAG(n) \
113 if (_v_##n != n) { \
114 ResourceMark rm; \
115 stringStream ss; \
116 ss.print("VM option %s is different between dumptime (", #n); \
117 do_print(&ss, _v_ ## n); \
118 ss.print(") and runtime ("); \
119 do_print(&ss, n); \
120 ss.print(")"); \
121 log_info(cds)("%s", ss.as_string()); \
122 return false; \
123 }
124 CDS_MUST_MATCH_FLAGS_DO(CHECK_CDS_MUST_MATCH_FLAG);
125 #undef CHECK_CDS_MUST_MATCH_FLAG
126
127 return true;
128 }
129
130 void CDSMustMatchFlags::print_info() const {
131 LogTarget(Info, cds) lt;
132 if (lt.is_enabled()) {
133 LogStream ls(lt);
134 ls.print_cr("Recorded VM flags during dumptime:");
135 print(&ls);
136 }
137 }
138
139 void CDSMustMatchFlags::print(outputStream* st) const {
140 #define PRINT_CDS_MUST_MATCH_FLAG(n) \
141 st->print("- %-s ", #n); \
142 st->sp(int(_max_name_width - strlen(#n))); \
143 do_print(st, _v_##n); \
144 st->cr();
145 CDS_MUST_MATCH_FLAGS_DO(PRINT_CDS_MUST_MATCH_FLAG);
146 #undef PRINT_CDS_MUST_MATCH_FLAG
147 }
148
149 // Fill in the fileMapInfo structure with data about this VM instance.
150
151 // This method copies the vm version info into header_version. If the version is too
152 // long then a truncated version, which has a hash code appended to it, is copied.
153 //
154 // Using a template enables this method to verify that header_version is an array of
155 // length JVM_IDENT_MAX. This ensures that the code that writes to the CDS file and
156 // the code that reads the CDS file will both use the same size buffer. Hence, will
157 // use identical truncation. This is necessary for matching of truncated versions.
158 template <int N> static void get_header_version(char (&header_version) [N]) {
159 assert(N == JVM_IDENT_MAX, "Bad header_version size");
160
161 const char *vm_version = VM_Version::internal_vm_info_string();
162 const int version_len = (int)strlen(vm_version);
163
164 memset(header_version, 0, JVM_IDENT_MAX);
165
166 if (version_len < (JVM_IDENT_MAX-1)) {
167 strcpy(header_version, vm_version);
168
169 } else {
170 // Get the hash value. Use a static seed because the hash needs to return the same
171 // value over multiple jvm invocations.
172 uint32_t hash = AltHashing::halfsiphash_32(8191, (const uint8_t*)vm_version, version_len);
173
174 // Truncate the ident, saving room for the 8 hex character hash value.
175 strncpy(header_version, vm_version, JVM_IDENT_MAX-9);
176
177 // Append the hash code as eight hex digits.
178 os::snprintf_checked(&header_version[JVM_IDENT_MAX-9], 9, "%08x", hash);
179 header_version[JVM_IDENT_MAX-1] = 0; // Null terminate.
180 }
181
182 assert(header_version[JVM_IDENT_MAX-1] == 0, "must be");
183 }
184
185 FileMapInfo::FileMapInfo(const char* full_path, bool is_static) :
186 _is_static(is_static), _file_open(false), _is_mapped(false), _fd(-1), _file_offset(0),
187 _full_path(full_path), _base_archive_name(nullptr), _header(nullptr) {
188 if (_is_static) {
189 assert(_current_info == nullptr, "must be singleton"); // not thread safe
190 _current_info = this;
191 } else {
192 assert(_dynamic_archive_info == nullptr, "must be singleton"); // not thread safe
193 _dynamic_archive_info = this;
194 }
195 }
196
197 FileMapInfo::~FileMapInfo() {
198 if (_is_static) {
199 assert(_current_info == this, "must be singleton"); // not thread safe
200 _current_info = nullptr;
201 } else {
202 assert(_dynamic_archive_info == this, "must be singleton"); // not thread safe
203 _dynamic_archive_info = nullptr;
204 }
205
206 if (_header != nullptr) {
207 os::free(_header);
208 }
209
210 if (_file_open) {
211 ::close(_fd);
212 }
213 }
214
215 void FileMapInfo::populate_header(size_t core_region_alignment) {
216 assert(_header == nullptr, "Sanity check");
217 size_t c_header_size;
218 size_t header_size;
219 size_t base_archive_name_size = 0;
220 size_t base_archive_name_offset = 0;
221 size_t longest_common_prefix_size = 0;
222 if (is_static()) {
223 c_header_size = sizeof(FileMapHeader);
224 header_size = c_header_size;
225 } else {
226 // dynamic header including base archive name for non-default base archive
227 c_header_size = sizeof(DynamicArchiveHeader);
228 header_size = c_header_size;
229
230 const char* default_base_archive_name = CDSConfig::default_archive_path();
231 const char* current_base_archive_name = CDSConfig::static_archive_path();
232 if (!os::same_files(current_base_archive_name, default_base_archive_name)) {
233 base_archive_name_size = strlen(current_base_archive_name) + 1;
234 header_size += base_archive_name_size;
235 base_archive_name_offset = c_header_size;
236 }
237 }
238 ResourceMark rm;
239 GrowableArray<const char*>* app_cp_array = create_dumptime_app_classpath_array();
240 int len = app_cp_array->length();
241 longest_common_prefix_size = longest_common_app_classpath_prefix_len(len, app_cp_array);
242 _header = (FileMapHeader*)os::malloc(header_size, mtInternal);
243 memset((void*)_header, 0, header_size);
244 _header->populate(this,
245 core_region_alignment,
246 header_size,
247 base_archive_name_size,
248 base_archive_name_offset,
249 longest_common_prefix_size);
250 }
251
252 void FileMapHeader::populate(FileMapInfo *info, size_t core_region_alignment,
253 size_t header_size, size_t base_archive_name_size,
254 size_t base_archive_name_offset, size_t common_app_classpath_prefix_size) {
255 // 1. We require _generic_header._magic to be at the beginning of the file
256 // 2. FileMapHeader also assumes that _generic_header is at the beginning of the file
257 assert(offset_of(FileMapHeader, _generic_header) == 0, "must be");
258 set_header_size((unsigned int)header_size);
259 set_base_archive_name_offset((unsigned int)base_archive_name_offset);
260 set_base_archive_name_size((unsigned int)base_archive_name_size);
261 set_common_app_classpath_prefix_size((unsigned int)common_app_classpath_prefix_size);
262 set_magic(CDSConfig::is_dumping_dynamic_archive() ? CDS_DYNAMIC_ARCHIVE_MAGIC : CDS_ARCHIVE_MAGIC);
263 set_version(CURRENT_CDS_ARCHIVE_VERSION);
264
265 if (!info->is_static() && base_archive_name_size != 0) {
266 // copy base archive name
267 copy_base_archive_name(CDSConfig::static_archive_path());
268 }
269 _core_region_alignment = core_region_alignment;
270 _obj_alignment = ObjectAlignmentInBytes;
271 _compact_strings = CompactStrings;
272 if (CDSConfig::is_dumping_heap()) {
273 _narrow_oop_mode = CompressedOops::mode();
274 _narrow_oop_base = CompressedOops::base();
275 _narrow_oop_shift = CompressedOops::shift();
276 }
277 _compressed_oops = UseCompressedOops;
278 _compressed_class_ptrs = UseCompressedClassPointers;
279 _max_heap_size = MaxHeapSize;
280 _use_optimized_module_handling = MetaspaceShared::use_optimized_module_handling();
281 _has_full_module_graph = CDSConfig::is_dumping_full_module_graph();
282 _has_valhalla_patched_classes = CDSConfig::is_valhalla_preview();
283 // The following fields are for sanity checks for whether this archive
284 // will function correctly with this JVM and the bootclasspath it's
285 // invoked with.
286
287 // JVM version string ... changes on each build.
288 get_header_version(_jvm_ident);
289
290 _app_class_paths_start_index = ClassLoaderExt::app_class_paths_start_index();
291 _app_module_paths_start_index = ClassLoaderExt::app_module_paths_start_index();
292 _max_used_path_index = ClassLoaderExt::max_used_path_index();
293 _num_module_paths = ClassLoader::num_module_path_entries();
294
295 _verify_local = BytecodeVerificationLocal;
296 _verify_remote = BytecodeVerificationRemote;
297 _has_platform_or_app_classes = ClassLoaderExt::has_platform_or_app_classes();
298 _has_non_jar_in_classpath = ClassLoaderExt::has_non_jar_in_classpath();
299 _requested_base_address = (char*)SharedBaseAddress;
300 _mapped_base_address = (char*)SharedBaseAddress;
301 _allow_archiving_with_java_agent = AllowArchivingWithJavaAgent;
302 _must_match.init();
303
304 if (!CDSConfig::is_dumping_dynamic_archive()) {
305 set_shared_path_table(info->_shared_path_table);
306 }
307 }
308
309 void FileMapHeader::copy_base_archive_name(const char* archive) {
310 assert(base_archive_name_size() != 0, "_base_archive_name_size not set");
311 assert(base_archive_name_offset() != 0, "_base_archive_name_offset not set");
312 assert(header_size() > sizeof(*this), "_base_archive_name_size not included in header size?");
313 memcpy((char*)this + base_archive_name_offset(), archive, base_archive_name_size());
314 }
315
316 void FileMapHeader::print(outputStream* st) {
317 ResourceMark rm;
318
319 st->print_cr("- magic: 0x%08x", magic());
320 st->print_cr("- crc: 0x%08x", crc());
321 st->print_cr("- version: 0x%x", version());
322 st->print_cr("- header_size: " UINT32_FORMAT, header_size());
323 st->print_cr("- common_app_classpath_size: " UINT32_FORMAT, common_app_classpath_prefix_size());
324 st->print_cr("- base_archive_name_offset: " UINT32_FORMAT, base_archive_name_offset());
325 st->print_cr("- base_archive_name_size: " UINT32_FORMAT, base_archive_name_size());
326
327 for (int i = 0; i < NUM_CDS_REGIONS; i++) {
328 FileMapRegion* r = region_at(i);
329 r->print(st, i);
330 }
331 st->print_cr("============ end regions ======== ");
332
333 st->print_cr("- core_region_alignment: " SIZE_FORMAT, _core_region_alignment);
334 st->print_cr("- obj_alignment: %d", _obj_alignment);
335 st->print_cr("- narrow_oop_base: " INTPTR_FORMAT, p2i(_narrow_oop_base));
336 st->print_cr("- narrow_oop_base: " INTPTR_FORMAT, p2i(_narrow_oop_base));
337 st->print_cr("- narrow_oop_shift %d", _narrow_oop_shift);
338 st->print_cr("- compact_strings: %d", _compact_strings);
339 st->print_cr("- max_heap_size: " UINTX_FORMAT, _max_heap_size);
340 st->print_cr("- narrow_oop_mode: %d", _narrow_oop_mode);
341 st->print_cr("- compressed_oops: %d", _compressed_oops);
342 st->print_cr("- compressed_class_ptrs: %d", _compressed_class_ptrs);
343 st->print_cr("- cloned_vtables_offset: " SIZE_FORMAT_X, _cloned_vtables_offset);
344 st->print_cr("- serialized_data_offset: " SIZE_FORMAT_X, _serialized_data_offset);
345 st->print_cr("- jvm_ident: %s", _jvm_ident);
346 st->print_cr("- shared_path_table_offset: " SIZE_FORMAT_X, _shared_path_table_offset);
347 st->print_cr("- app_class_paths_start_index: %d", _app_class_paths_start_index);
348 st->print_cr("- app_module_paths_start_index: %d", _app_module_paths_start_index);
349 st->print_cr("- num_module_paths: %d", _num_module_paths);
350 st->print_cr("- max_used_path_index: %d", _max_used_path_index);
351 st->print_cr("- verify_local: %d", _verify_local);
352 st->print_cr("- verify_remote: %d", _verify_remote);
353 st->print_cr("- has_platform_or_app_classes: %d", _has_platform_or_app_classes);
354 st->print_cr("- has_non_jar_in_classpath: %d", _has_non_jar_in_classpath);
355 st->print_cr("- requested_base_address: " INTPTR_FORMAT, p2i(_requested_base_address));
356 st->print_cr("- mapped_base_address: " INTPTR_FORMAT, p2i(_mapped_base_address));
357 st->print_cr("- heap_roots_offset: " SIZE_FORMAT, _heap_roots_offset);
358 st->print_cr("- allow_archiving_with_java_agent:%d", _allow_archiving_with_java_agent);
359 st->print_cr("- use_optimized_module_handling: %d", _use_optimized_module_handling);
360 st->print_cr("- has_full_module_graph %d", _has_full_module_graph);
361 st->print_cr("- has_valhalla_patched_classes %d", _has_valhalla_patched_classes);
362 st->print_cr("- ptrmap_size_in_bits: " SIZE_FORMAT, _ptrmap_size_in_bits);
363 _must_match.print(st);
364 }
365
366 void SharedClassPathEntry::init_as_non_existent(const char* path, TRAPS) {
367 _type = non_existent_entry;
368 set_name(path, CHECK);
369 }
370
371 void SharedClassPathEntry::init(bool is_modules_image,
372 bool is_module_path,
373 ClassPathEntry* cpe, TRAPS) {
374 assert(CDSConfig::is_dumping_archive(), "sanity");
375 _timestamp = 0;
376 _filesize = 0;
377 _from_class_path_attr = false;
378
379 struct stat st;
380 if (os::stat(cpe->name(), &st) == 0) {
381 if ((st.st_mode & S_IFMT) == S_IFDIR) {
382 _type = dir_entry;
383 } else {
384 // The timestamp of the modules_image is not checked at runtime.
385 if (is_modules_image) {
386 _type = modules_image_entry;
387 } else {
388 _type = jar_entry;
389 _timestamp = st.st_mtime;
390 _from_class_path_attr = cpe->from_class_path_attr();
391 }
392 _filesize = st.st_size;
393 _is_module_path = is_module_path;
394 }
395 } else {
396 // The file/dir must exist, or it would not have been added
397 // into ClassLoader::classpath_entry().
398 //
399 // If we can't access a jar file in the boot path, then we can't
400 // make assumptions about where classes get loaded from.
401 log_error(cds)("Unable to open file %s.", cpe->name());
402 MetaspaceShared::unrecoverable_loading_error();
403 }
404
405 // No need to save the name of the module file, as it will be computed at run time
406 // to allow relocation of the JDK directory.
407 const char* name = is_modules_image ? "" : cpe->name();
408 set_name(name, CHECK);
409 }
410
411 void SharedClassPathEntry::set_name(const char* name, TRAPS) {
412 size_t len = strlen(name) + 1;
413 _name = MetadataFactory::new_array<char>(ClassLoaderData::the_null_class_loader_data(), (int)len, CHECK);
414 strcpy(_name->data(), name);
415 }
416
417 void SharedClassPathEntry::copy_from(SharedClassPathEntry* ent, ClassLoaderData* loader_data, TRAPS) {
418 assert(ent != nullptr, "sanity");
419 _type = ent->_type;
420 _is_module_path = ent->_is_module_path;
421 _timestamp = ent->_timestamp;
422 _filesize = ent->_filesize;
423 _from_class_path_attr = ent->_from_class_path_attr;
424 set_name(ent->name(), CHECK);
425
426 if (ent->is_jar() && ent->manifest() != nullptr) {
427 Array<u1>* buf = MetadataFactory::new_array<u1>(loader_data,
428 ent->manifest_size(),
429 CHECK);
430 char* p = (char*)(buf->data());
431 memcpy(p, ent->manifest(), ent->manifest_size());
432 set_manifest(buf);
433 }
434 }
435
436 const char* SharedClassPathEntry::name() const {
437 if (UseSharedSpaces && is_modules_image()) {
438 // In order to validate the runtime modules image file size against the archived
439 // size information, we need to obtain the runtime modules image path. The recorded
440 // dump time modules image path in the archive may be different from the runtime path
441 // if the JDK image has beed moved after generating the archive.
442 return ClassLoader::get_jrt_entry()->name();
443 } else {
444 return _name->data();
445 }
446 }
447
448 bool SharedClassPathEntry::validate(bool is_class_path) const {
449 assert(UseSharedSpaces, "runtime only");
450
451 struct stat st;
452 const char* name = this->name();
453
454 bool ok = true;
455 log_info(class, path)("checking shared classpath entry: %s", name);
456 if (os::stat(name, &st) != 0 && is_class_path) {
457 // If the archived module path entry does not exist at runtime, it is not fatal
458 // (no need to invalid the shared archive) because the shared runtime visibility check
459 // filters out any archived module classes that do not have a matching runtime
460 // module path location.
461 log_warning(cds)("Required classpath entry does not exist: %s", name);
462 ok = false;
463 } else if (is_dir()) {
464 if (!os::dir_is_empty(name)) {
465 log_warning(cds)("directory is not empty: %s", name);
466 ok = false;
467 }
468 } else {
469 bool size_differs = _filesize != st.st_size;
470 bool time_differs = has_timestamp() && _timestamp != st.st_mtime;
471 if (time_differs || size_differs) {
472 ok = false;
473 if (PrintSharedArchiveAndExit) {
474 log_warning(cds)(time_differs ? "Timestamp mismatch" : "File size mismatch");
475 } else {
476 const char* bad_file_msg = "This file is not the one used while building the shared archive file:";
477 log_warning(cds)("%s %s", bad_file_msg, name);
478 if (!log_is_enabled(Info, cds)) {
479 log_warning(cds)("%s %s", bad_file_msg, name);
480 }
481 if (time_differs) {
482 log_warning(cds)("%s timestamp has changed.", name);
483 }
484 if (size_differs) {
485 log_warning(cds)("%s size has changed.", name);
486 }
487 }
488 }
489 }
490
491 if (PrintSharedArchiveAndExit && !ok) {
492 // If PrintSharedArchiveAndExit is enabled, don't report failure to the
493 // caller. Please see above comments for more details.
494 ok = true;
495 MetaspaceShared::set_archive_loading_failed();
496 }
497 return ok;
498 }
499
500 bool SharedClassPathEntry::check_non_existent() const {
501 assert(_type == non_existent_entry, "must be");
502 log_info(class, path)("should be non-existent: %s", name());
503 struct stat st;
504 if (os::stat(name(), &st) != 0) {
505 log_info(class, path)("ok");
506 return true; // file doesn't exist
507 } else {
508 return false;
509 }
510 }
511
512 void SharedClassPathEntry::metaspace_pointers_do(MetaspaceClosure* it) {
513 it->push(&_name);
514 it->push(&_manifest);
515 }
516
517 void SharedPathTable::metaspace_pointers_do(MetaspaceClosure* it) {
518 it->push(&_entries);
519 }
520
521 void SharedPathTable::dumptime_init(ClassLoaderData* loader_data, TRAPS) {
522 const int num_entries =
523 ClassLoader::num_boot_classpath_entries() +
524 ClassLoader::num_app_classpath_entries() +
525 ClassLoader::num_module_path_entries() +
526 FileMapInfo::num_non_existent_class_paths();
527 _entries = MetadataFactory::new_array<SharedClassPathEntry*>(loader_data, num_entries, CHECK);
528 for (int i = 0; i < num_entries; i++) {
529 SharedClassPathEntry* ent =
530 new (loader_data, SharedClassPathEntry::size(), MetaspaceObj::SharedClassPathEntryType, THREAD) SharedClassPathEntry;
531 _entries->at_put(i, ent);
532 }
533 }
534
535 void FileMapInfo::allocate_shared_path_table(TRAPS) {
536 assert(CDSConfig::is_dumping_archive(), "sanity");
537
538 ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();
539 ClassPathEntry* jrt = ClassLoader::get_jrt_entry();
540
541 assert(jrt != nullptr,
542 "No modular java runtime image present when allocating the CDS classpath entry table");
543
544 _shared_path_table.dumptime_init(loader_data, CHECK);
545
546 // 1. boot class path
547 int i = 0;
548 i = add_shared_classpaths(i, "boot", jrt, CHECK);
549 i = add_shared_classpaths(i, "app", ClassLoader::app_classpath_entries(), CHECK);
550 i = add_shared_classpaths(i, "module", ClassLoader::module_path_entries(), CHECK);
551
552 for (int x = 0; x < num_non_existent_class_paths(); x++, i++) {
553 const char* path = _non_existent_class_paths->at(x);
554 shared_path(i)->init_as_non_existent(path, CHECK);
555 }
556
557 assert(i == _shared_path_table.size(), "number of shared path entry mismatch");
558 }
559
560 int FileMapInfo::add_shared_classpaths(int i, const char* which, ClassPathEntry *cpe, TRAPS) {
561 while (cpe != nullptr) {
562 bool is_jrt = (cpe == ClassLoader::get_jrt_entry());
563 bool is_module_path = i >= ClassLoaderExt::app_module_paths_start_index();
564 const char* type = (is_jrt ? "jrt" : (cpe->is_jar_file() ? "jar" : "dir"));
565 log_info(class, path)("add %s shared path (%s) %s", which, type, cpe->name());
566 SharedClassPathEntry* ent = shared_path(i);
567 ent->init(is_jrt, is_module_path, cpe, CHECK_0);
568 if (cpe->is_jar_file()) {
569 update_jar_manifest(cpe, ent, CHECK_0);
570 }
571 if (is_jrt) {
572 cpe = ClassLoader::get_next_boot_classpath_entry(cpe);
573 } else {
574 cpe = cpe->next();
575 }
576 i++;
577 }
578
579 return i;
580 }
581
582 void FileMapInfo::check_nonempty_dir_in_shared_path_table() {
583 assert(CDSConfig::is_dumping_archive(), "sanity");
584
585 bool has_nonempty_dir = false;
586
587 int last = _shared_path_table.size() - 1;
588 if (last > ClassLoaderExt::max_used_path_index()) {
589 // no need to check any path beyond max_used_path_index
590 last = ClassLoaderExt::max_used_path_index();
591 }
592
593 for (int i = 0; i <= last; i++) {
594 SharedClassPathEntry *e = shared_path(i);
595 if (e->is_dir()) {
596 const char* path = e->name();
597 if (!os::dir_is_empty(path)) {
598 log_error(cds)("Error: non-empty directory '%s'", path);
599 has_nonempty_dir = true;
600 }
601 }
602 }
603
604 if (has_nonempty_dir) {
605 ClassLoader::exit_with_path_failure("Cannot have non-empty directory in paths", nullptr);
606 }
607 }
608
609 void FileMapInfo::record_non_existent_class_path_entry(const char* path) {
610 assert(CDSConfig::is_dumping_archive(), "sanity");
611 log_info(class, path)("non-existent Class-Path entry %s", path);
612 if (_non_existent_class_paths == nullptr) {
613 _non_existent_class_paths = new (mtClass) GrowableArray<const char*>(10, mtClass);
614 }
615 _non_existent_class_paths->append(os::strdup(path));
616 }
617
618 int FileMapInfo::num_non_existent_class_paths() {
619 assert(CDSConfig::is_dumping_archive(), "sanity");
620 if (_non_existent_class_paths != nullptr) {
621 return _non_existent_class_paths->length();
622 } else {
623 return 0;
624 }
625 }
626
627 int FileMapInfo::get_module_shared_path_index(Symbol* location) {
628 if (location->starts_with("jrt:", 4) && get_number_of_shared_paths() > 0) {
629 assert(shared_path(0)->is_modules_image(), "first shared_path must be the modules image");
630 return 0;
631 }
632
633 if (ClassLoaderExt::app_module_paths_start_index() >= get_number_of_shared_paths()) {
634 // The archive(s) were created without --module-path option
635 return -1;
636 }
637
638 if (!location->starts_with("file:", 5)) {
639 return -1;
640 }
641
642 // skip_uri_protocol was also called during dump time -- see ClassLoaderExt::process_module_table()
643 ResourceMark rm;
644 const char* file = ClassLoader::skip_uri_protocol(location->as_C_string());
645 for (int i = ClassLoaderExt::app_module_paths_start_index(); i < get_number_of_shared_paths(); i++) {
646 SharedClassPathEntry* ent = shared_path(i);
647 if (!ent->is_non_existent()) {
648 assert(ent->in_named_module(), "must be");
649 bool cond = strcmp(file, ent->name()) == 0;
650 log_debug(class, path)("get_module_shared_path_index (%d) %s : %s = %s", i,
651 location->as_C_string(), ent->name(), cond ? "same" : "different");
652 if (cond) {
653 return i;
654 }
655 }
656 }
657
658 return -1;
659 }
660
661 class ManifestStream: public ResourceObj {
662 private:
663 u1* _buffer_start; // Buffer bottom
664 u1* _buffer_end; // Buffer top (one past last element)
665 u1* _current; // Current buffer position
666
667 public:
668 // Constructor
669 ManifestStream(u1* buffer, int length) : _buffer_start(buffer),
670 _current(buffer) {
671 _buffer_end = buffer + length;
672 }
673
674 static bool is_attr(u1* attr, const char* name) {
675 return strncmp((const char*)attr, name, strlen(name)) == 0;
676 }
677
678 static char* copy_attr(u1* value, size_t len) {
679 char* buf = NEW_RESOURCE_ARRAY(char, len + 1);
680 strncpy(buf, (char*)value, len);
681 buf[len] = 0;
682 return buf;
683 }
684 };
685
686 void FileMapInfo::update_jar_manifest(ClassPathEntry *cpe, SharedClassPathEntry* ent, TRAPS) {
687 ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();
688 ResourceMark rm(THREAD);
689 jint manifest_size;
690
691 assert(cpe->is_jar_file() && ent->is_jar(), "the shared class path entry is not a JAR file");
692 char* manifest = ClassLoaderExt::read_manifest(THREAD, cpe, &manifest_size);
693 if (manifest != nullptr) {
694 ManifestStream* stream = new ManifestStream((u1*)manifest,
695 manifest_size);
696 // Copy the manifest into the shared archive
697 manifest = ClassLoaderExt::read_raw_manifest(THREAD, cpe, &manifest_size);
698 Array<u1>* buf = MetadataFactory::new_array<u1>(loader_data,
699 manifest_size,
700 CHECK);
701 char* p = (char*)(buf->data());
702 memcpy(p, manifest, manifest_size);
703 ent->set_manifest(buf);
704 }
705 }
706
707 char* FileMapInfo::skip_first_path_entry(const char* path) {
708 size_t path_sep_len = strlen(os::path_separator());
709 char* p = strstr((char*)path, os::path_separator());
710 if (p != nullptr) {
711 debug_only( {
712 size_t image_name_len = strlen(MODULES_IMAGE_NAME);
713 assert(strncmp(p - image_name_len, MODULES_IMAGE_NAME, image_name_len) == 0,
714 "first entry must be the modules image");
715 } );
716 p += path_sep_len;
717 } else {
718 debug_only( {
719 assert(ClassLoader::string_ends_with(path, MODULES_IMAGE_NAME),
720 "first entry must be the modules image");
721 } );
722 }
723 return p;
724 }
725
726 int FileMapInfo::num_paths(const char* path) {
727 if (path == nullptr) {
728 return 0;
729 }
730 int npaths = 1;
731 char* p = (char*)path;
732 while (p != nullptr) {
733 char* prev = p;
734 p = strstr((char*)p, os::path_separator());
735 if (p != nullptr) {
736 p++;
737 // don't count empty path
738 if ((p - prev) > 1) {
739 npaths++;
740 }
741 }
742 }
743 return npaths;
744 }
745
746 // Returns true if a path within the paths exists and has non-zero size.
747 bool FileMapInfo::check_paths_existence(const char* paths) {
748 ClasspathStream cp_stream(paths);
749 bool exist = false;
750 struct stat st;
751 while (cp_stream.has_next()) {
752 const char* path = cp_stream.get_next();
753 if (os::stat(path, &st) == 0 && st.st_size > 0) {
754 exist = true;
755 break;
756 }
757 }
758 return exist;
759 }
760
761 GrowableArray<const char*>* FileMapInfo::create_dumptime_app_classpath_array() {
762 assert(CDSConfig::is_dumping_archive(), "sanity");
763 GrowableArray<const char*>* path_array = new GrowableArray<const char*>(10);
764 ClassPathEntry* cpe = ClassLoader::app_classpath_entries();
765 while (cpe != nullptr) {
766 path_array->append(cpe->name());
767 cpe = cpe->next();
768 }
769 return path_array;
770 }
771
772 GrowableArray<const char*>* FileMapInfo::create_path_array(const char* paths) {
773 GrowableArray<const char*>* path_array = new GrowableArray<const char*>(10);
774 JavaThread* current = JavaThread::current();
775 ClasspathStream cp_stream(paths);
776 bool non_jar_in_cp = header()->has_non_jar_in_classpath();
777 while (cp_stream.has_next()) {
778 const char* path = cp_stream.get_next();
779 if (!non_jar_in_cp) {
780 struct stat st;
781 if (os::stat(path, &st) == 0) {
782 path_array->append(path);
783 }
784 } else {
785 const char* canonical_path = ClassLoader::get_canonical_path(path, current);
786 if (canonical_path != nullptr) {
787 char* error_msg = nullptr;
788 jzfile* zip = ClassLoader::open_zip_file(canonical_path, &error_msg, current);
789 if (zip != nullptr && error_msg == nullptr) {
790 path_array->append(path);
791 }
792 }
793 }
794 }
795 return path_array;
796 }
797
798 bool FileMapInfo::classpath_failure(const char* msg, const char* name) {
799 ClassLoader::trace_class_path(msg, name);
800 if (PrintSharedArchiveAndExit) {
801 MetaspaceShared::set_archive_loading_failed();
802 }
803 return false;
804 }
805
806 unsigned int FileMapInfo::longest_common_app_classpath_prefix_len(int num_paths,
807 GrowableArray<const char*>* rp_array) {
808 if (num_paths == 0) {
809 return 0;
810 }
811 unsigned int pos;
812 for (pos = 0; ; pos++) {
813 for (int i = 0; i < num_paths; i++) {
814 if (rp_array->at(i)[pos] != '\0' && rp_array->at(i)[pos] == rp_array->at(0)[pos]) {
815 continue;
816 }
817 // search backward for the pos before the file separator char
818 while (pos > 0) {
819 if (rp_array->at(0)[--pos] == *os::file_separator()) {
820 return pos + 1;
821 }
822 }
823 return 0;
824 }
825 }
826 return 0;
827 }
828
829 bool FileMapInfo::check_paths(int shared_path_start_idx, int num_paths, GrowableArray<const char*>* rp_array,
830 unsigned int dumptime_prefix_len, unsigned int runtime_prefix_len) {
831 int i = 0;
832 int j = shared_path_start_idx;
833 while (i < num_paths) {
834 while (shared_path(j)->from_class_path_attr()) {
835 // shared_path(j) was expanded from the JAR file attribute "Class-Path:"
836 // during dump time. It's not included in the -classpath VM argument.
837 j++;
838 }
839 assert(strlen(shared_path(j)->name()) > (size_t)dumptime_prefix_len, "sanity");
840 const char* dumptime_path = shared_path(j)->name() + dumptime_prefix_len;
841 assert(strlen(rp_array->at(i)) > (size_t)runtime_prefix_len, "sanity");
842 const char* runtime_path = rp_array->at(i) + runtime_prefix_len;
843 if (!os::same_files(dumptime_path, runtime_path)) {
844 return true;
845 }
846 i++;
847 j++;
848 }
849 return false;
850 }
851
852 bool FileMapInfo::validate_boot_class_paths() {
853 //
854 // - Archive contains boot classes only - relaxed boot path check:
855 // Extra path elements appended to the boot path at runtime are allowed.
856 //
857 // - Archive contains application or platform classes - strict boot path check:
858 // Validate the entire runtime boot path, which must be compatible
859 // with the dump time boot path. Appending boot path at runtime is not
860 // allowed.
861 //
862
863 // The first entry in boot path is the modules_image (guaranteed by
864 // ClassLoader::setup_boot_search_path()). Skip the first entry. The
865 // path of the runtime modules_image may be different from the dump
866 // time path (e.g. the JDK image is copied to a different location
867 // after generating the shared archive), which is acceptable. For most
868 // common cases, the dump time boot path might contain modules_image only.
869 char* runtime_boot_path = Arguments::get_boot_class_path();
870 char* rp = skip_first_path_entry(runtime_boot_path);
871 assert(shared_path(0)->is_modules_image(), "first shared_path must be the modules image");
872 int dp_len = header()->app_class_paths_start_index() - 1; // ignore the first path to the module image
873 bool mismatch = false;
874
875 bool relaxed_check = !header()->has_platform_or_app_classes();
876 if (dp_len == 0 && rp == nullptr) {
877 return true; // ok, both runtime and dump time boot paths have modules_images only
878 } else if (dp_len == 0 && rp != nullptr) {
879 if (relaxed_check) {
880 return true; // ok, relaxed check, runtime has extra boot append path entries
881 } else {
882 ResourceMark rm;
883 if (check_paths_existence(rp)) {
884 // If a path exists in the runtime boot paths, it is considered a mismatch
885 // since there's no boot path specified during dump time.
886 mismatch = true;
887 }
888 }
889 } else if (dp_len > 0 && rp != nullptr) {
890 int num;
891 ResourceMark rm;
892 GrowableArray<const char*>* rp_array = create_path_array(rp);
893 int rp_len = rp_array->length();
894 if (rp_len >= dp_len) {
895 if (relaxed_check) {
896 // only check the leading entries in the runtime boot path, up to
897 // the length of the dump time boot path
898 num = dp_len;
899 } else {
900 // check the full runtime boot path, must match with dump time
901 num = rp_len;
902 }
903 mismatch = check_paths(1, num, rp_array, 0, 0);
904 } else {
905 // create_path_array() ignores non-existing paths. Although the dump time and runtime boot classpath lengths
906 // are the same initially, after the call to create_path_array(), the runtime boot classpath length could become
907 // shorter. We consider boot classpath mismatch in this case.
908 mismatch = true;
909 }
910 }
911
912 if (mismatch) {
913 // The paths are different
914 return classpath_failure("[BOOT classpath mismatch, actual =", runtime_boot_path);
915 }
916 return true;
917 }
918
919 bool FileMapInfo::validate_app_class_paths(int shared_app_paths_len) {
920 const char *appcp = Arguments::get_appclasspath();
921 assert(appcp != nullptr, "null app classpath");
922 int rp_len = num_paths(appcp);
923 bool mismatch = false;
924 if (rp_len < shared_app_paths_len) {
925 return classpath_failure("Run time APP classpath is shorter than the one at dump time: ", appcp);
926 }
927 if (shared_app_paths_len != 0 && rp_len != 0) {
928 // Prefix is OK: E.g., dump with -cp foo.jar, but run with -cp foo.jar:bar.jar.
929 ResourceMark rm;
930 GrowableArray<const char*>* rp_array = create_path_array(appcp);
931 if (rp_array->length() == 0) {
932 // None of the jar file specified in the runtime -cp exists.
933 return classpath_failure("None of the jar file specified in the runtime -cp exists: -Djava.class.path=", appcp);
934 }
935 if (rp_array->length() < shared_app_paths_len) {
936 // create_path_array() ignores non-existing paths. Although the dump time and runtime app classpath lengths
937 // are the same initially, after the call to create_path_array(), the runtime app classpath length could become
938 // shorter. We consider app classpath mismatch in this case.
939 return classpath_failure("[APP classpath mismatch, actual: -Djava.class.path=", appcp);
940 }
941
942 // Handling of non-existent entries in the classpath: we eliminate all the non-existent
943 // entries from both the dump time classpath (ClassLoader::update_class_path_entry_list)
944 // and the runtime classpath (FileMapInfo::create_path_array), and check the remaining
945 // entries. E.g.:
946 //
947 // dump : -cp a.jar:NE1:NE2:b.jar -> a.jar:b.jar -> recorded in archive.
948 // run 1: -cp NE3:a.jar:NE4:b.jar -> a.jar:b.jar -> matched
949 // run 2: -cp x.jar:NE4:b.jar -> x.jar:b.jar -> mismatched
950
951 int j = header()->app_class_paths_start_index();
952 mismatch = check_paths(j, shared_app_paths_len, rp_array, 0, 0);
953 if (mismatch) {
954 // To facilitate app deployment, we allow the JAR files to be moved *together* to
955 // a different location, as long as they are still stored under the same directory
956 // structure. E.g., the following is OK.
957 // java -Xshare:dump -cp /a/Foo.jar:/a/b/Bar.jar ...
958 // java -Xshare:auto -cp /x/y/Foo.jar:/x/y/b/Bar.jar ...
959 unsigned int dumptime_prefix_len = header()->common_app_classpath_prefix_size();
960 unsigned int runtime_prefix_len = longest_common_app_classpath_prefix_len(shared_app_paths_len, rp_array);
961 if (dumptime_prefix_len != 0 || runtime_prefix_len != 0) {
962 log_info(class, path)("LCP length for app classpath (dumptime: %u, runtime: %u)",
963 dumptime_prefix_len, runtime_prefix_len);
964 mismatch = check_paths(j, shared_app_paths_len, rp_array,
965 dumptime_prefix_len, runtime_prefix_len);
966 }
967 if (mismatch) {
968 return classpath_failure("[APP classpath mismatch, actual: -Djava.class.path=", appcp);
969 }
970 }
971 }
972 return true;
973 }
974
975 void FileMapInfo::log_paths(const char* msg, int start_idx, int end_idx) {
976 LogTarget(Info, class, path) lt;
977 if (lt.is_enabled()) {
978 LogStream ls(lt);
979 ls.print("%s", msg);
980 const char* prefix = "";
981 for (int i = start_idx; i < end_idx; i++) {
982 ls.print("%s%s", prefix, shared_path(i)->name());
983 prefix = os::path_separator();
984 }
985 ls.cr();
986 }
987 }
988
989 bool FileMapInfo::check_module_paths() {
990 const char* rp = Arguments::get_property("jdk.module.path");
991 int num_paths = CDSConfig::num_archives(rp);
992 if (num_paths != header()->num_module_paths()) {
993 return false;
994 }
995 ResourceMark rm;
996 GrowableArray<const char*>* rp_array = create_path_array(rp);
997 return check_paths(header()->app_module_paths_start_index(), num_paths, rp_array, 0, 0);
998 }
999
1000 bool FileMapInfo::validate_shared_path_table() {
1001 assert(UseSharedSpaces, "runtime only");
1002
1003 _validating_shared_path_table = true;
1004
1005 // Load the shared path table info from the archive header
1006 _shared_path_table = header()->shared_path_table();
1007 if (CDSConfig::is_dumping_dynamic_archive()) {
1008 // Only support dynamic dumping with the usage of the default CDS archive
1009 // or a simple base archive.
1010 // If the base layer archive contains additional path component besides
1011 // the runtime image and the -cp, dynamic dumping is disabled.
1012 //
1013 // When dynamic archiving is enabled, the _shared_path_table is overwritten
1014 // to include the application path and stored in the top layer archive.
1015 assert(shared_path(0)->is_modules_image(), "first shared_path must be the modules image");
1016 if (header()->app_class_paths_start_index() > 1) {
1017 CDSConfig::disable_dumping_dynamic_archive();
1018 log_warning(cds)(
1019 "Dynamic archiving is disabled because base layer archive has appended boot classpath");
1020 }
1021 if (header()->num_module_paths() > 0) {
1022 if (!check_module_paths()) {
1023 CDSConfig::disable_dumping_dynamic_archive();
1024 log_warning(cds)(
1025 "Dynamic archiving is disabled because base layer archive has a different module path");
1026 }
1027 }
1028 }
1029
1030 log_paths("Expecting BOOT path=", 0, header()->app_class_paths_start_index());
1031 log_paths("Expecting -Djava.class.path=", header()->app_class_paths_start_index(), header()->app_module_paths_start_index());
1032
1033 int module_paths_start_index = header()->app_module_paths_start_index();
1034 int shared_app_paths_len = 0;
1035
1036 // validate the path entries up to the _max_used_path_index
1037 for (int i=0; i < header()->max_used_path_index() + 1; i++) {
1038 if (i < module_paths_start_index) {
1039 if (shared_path(i)->validate()) {
1040 // Only count the app class paths not from the "Class-path" attribute of a jar manifest.
1041 if (!shared_path(i)->from_class_path_attr() && i >= header()->app_class_paths_start_index()) {
1042 shared_app_paths_len++;
1043 }
1044 log_info(class, path)("ok");
1045 } else {
1046 if (_dynamic_archive_info != nullptr && _dynamic_archive_info->_is_static) {
1047 assert(!UseSharedSpaces, "UseSharedSpaces should be disabled");
1048 }
1049 return false;
1050 }
1051 } else if (i >= module_paths_start_index) {
1052 if (shared_path(i)->validate(false /* not a class path entry */)) {
1053 log_info(class, path)("ok");
1054 } else {
1055 if (_dynamic_archive_info != nullptr && _dynamic_archive_info->_is_static) {
1056 assert(!UseSharedSpaces, "UseSharedSpaces should be disabled");
1057 }
1058 return false;
1059 }
1060 }
1061 }
1062
1063 if (header()->max_used_path_index() == 0) {
1064 // default archive only contains the module image in the bootclasspath
1065 assert(shared_path(0)->is_modules_image(), "first shared_path must be the modules image");
1066 } else {
1067 if (!validate_boot_class_paths() || !validate_app_class_paths(shared_app_paths_len)) {
1068 const char* mismatch_msg = "shared class paths mismatch";
1069 const char* hint_msg = log_is_enabled(Info, class, path) ?
1070 "" : " (hint: enable -Xlog:class+path=info to diagnose the failure)";
1071 if (RequireSharedSpaces) {
1072 log_error(cds)("%s%s", mismatch_msg, hint_msg);
1073 MetaspaceShared::unrecoverable_loading_error();
1074 } else {
1075 log_warning(cds)("%s%s", mismatch_msg, hint_msg);
1076 }
1077 return false;
1078 }
1079 }
1080
1081 validate_non_existent_class_paths();
1082
1083 _validating_shared_path_table = false;
1084
1085 #if INCLUDE_JVMTI
1086 if (_classpath_entries_for_jvmti != nullptr) {
1087 os::free(_classpath_entries_for_jvmti);
1088 }
1089 size_t sz = sizeof(ClassPathEntry*) * get_number_of_shared_paths();
1090 _classpath_entries_for_jvmti = (ClassPathEntry**)os::malloc(sz, mtClass);
1091 memset((void*)_classpath_entries_for_jvmti, 0, sz);
1092 #endif
1093
1094 return true;
1095 }
1096
1097 void FileMapInfo::validate_non_existent_class_paths() {
1098 // All of the recorded non-existent paths came from the Class-Path: attribute from the JAR
1099 // files on the app classpath. If any of these are found to exist during runtime,
1100 // it will change how classes are loading for the app loader. For safety, disable
1101 // loading of archived platform/app classes (currently there's no way to disable just the
1102 // app classes).
1103
1104 assert(UseSharedSpaces, "runtime only");
1105 for (int i = header()->app_module_paths_start_index() + header()->num_module_paths();
1106 i < get_number_of_shared_paths();
1107 i++) {
1108 SharedClassPathEntry* ent = shared_path(i);
1109 if (!ent->check_non_existent()) {
1110 log_warning(cds)("Archived non-system classes are disabled because the "
1111 "file %s exists", ent->name());
1112 header()->set_has_platform_or_app_classes(false);
1113 }
1114 }
1115 }
1116
1117 // A utility class for reading/validating the GenericCDSFileMapHeader portion of
1118 // a CDS archive's header. The file header of all CDS archives with versions from
1119 // CDS_GENERIC_HEADER_SUPPORTED_MIN_VERSION (12) are guaranteed to always start
1120 // with GenericCDSFileMapHeader. This makes it possible to read important information
1121 // from a CDS archive created by a different version of HotSpot, so that we can
1122 // automatically regenerate the archive as necessary (JDK-8261455).
1123 class FileHeaderHelper {
1124 int _fd;
1125 bool _is_valid;
1126 bool _is_static;
1127 GenericCDSFileMapHeader* _header;
1128 const char* _archive_name;
1129 const char* _base_archive_name;
1130
1131 public:
1132 FileHeaderHelper(const char* archive_name, bool is_static) {
1133 _fd = -1;
1134 _is_valid = false;
1135 _header = nullptr;
1136 _base_archive_name = nullptr;
1137 _archive_name = archive_name;
1138 _is_static = is_static;
1139 }
1140
1141 ~FileHeaderHelper() {
1142 if (_header != nullptr) {
1143 FREE_C_HEAP_ARRAY(char, _header);
1144 }
1145 if (_fd != -1) {
1146 ::close(_fd);
1147 }
1148 }
1149
1150 bool initialize() {
1151 assert(_archive_name != nullptr, "Archive name is null");
1152 _fd = os::open(_archive_name, O_RDONLY | O_BINARY, 0);
1153 if (_fd < 0) {
1154 log_info(cds)("Specified shared archive not found (%s)", _archive_name);
1155 return false;
1156 }
1157 return initialize(_fd);
1158 }
1159
1160 // for an already opened file, do not set _fd
1161 bool initialize(int fd) {
1162 assert(_archive_name != nullptr, "Archive name is null");
1163 assert(fd != -1, "Archive must be opened already");
1164 // First read the generic header so we know the exact size of the actual header.
1165 GenericCDSFileMapHeader gen_header;
1166 size_t size = sizeof(GenericCDSFileMapHeader);
1167 os::lseek(fd, 0, SEEK_SET);
1168 size_t n = ::read(fd, (void*)&gen_header, (unsigned int)size);
1169 if (n != size) {
1170 log_warning(cds)("Unable to read generic CDS file map header from shared archive");
1171 return false;
1172 }
1173
1174 if (gen_header._magic != CDS_ARCHIVE_MAGIC &&
1175 gen_header._magic != CDS_DYNAMIC_ARCHIVE_MAGIC) {
1176 log_warning(cds)("The shared archive file has a bad magic number: %#x", gen_header._magic);
1177 return false;
1178 }
1179
1180 if (gen_header._version < CDS_GENERIC_HEADER_SUPPORTED_MIN_VERSION) {
1181 log_warning(cds)("Cannot handle shared archive file version 0x%x. Must be at least 0x%x.",
1182 gen_header._version, CDS_GENERIC_HEADER_SUPPORTED_MIN_VERSION);
1183 return false;
1184 }
1185
1186 if (gen_header._version != CURRENT_CDS_ARCHIVE_VERSION) {
1187 log_warning(cds)("The shared archive file version 0x%x does not match the required version 0x%x.",
1188 gen_header._version, CURRENT_CDS_ARCHIVE_VERSION);
1189 }
1190
1191 size_t filelen = os::lseek(fd, 0, SEEK_END);
1192 if (gen_header._header_size >= filelen) {
1193 log_warning(cds)("Archive file header larger than archive file");
1194 return false;
1195 }
1196
1197 // Read the actual header and perform more checks
1198 size = gen_header._header_size;
1199 _header = (GenericCDSFileMapHeader*)NEW_C_HEAP_ARRAY(char, size, mtInternal);
1200 os::lseek(fd, 0, SEEK_SET);
1201 n = ::read(fd, (void*)_header, (unsigned int)size);
1202 if (n != size) {
1203 log_warning(cds)("Unable to read actual CDS file map header from shared archive");
1204 return false;
1205 }
1206
1207 if (!check_header_crc()) {
1208 return false;
1209 }
1210
1211 if (!check_and_init_base_archive_name()) {
1212 return false;
1213 }
1214
1215 // All fields in the GenericCDSFileMapHeader has been validated.
1216 _is_valid = true;
1217 return true;
1218 }
1219
1220 GenericCDSFileMapHeader* get_generic_file_header() {
1221 assert(_header != nullptr && _is_valid, "must be a valid archive file");
1222 return _header;
1223 }
1224
1225 const char* base_archive_name() {
1226 assert(_header != nullptr && _is_valid, "must be a valid archive file");
1227 return _base_archive_name;
1228 }
1229
1230 private:
1231 bool check_header_crc() const {
1232 if (VerifySharedSpaces) {
1233 FileMapHeader* header = (FileMapHeader*)_header;
1234 int actual_crc = header->compute_crc();
1235 if (actual_crc != header->crc()) {
1236 log_info(cds)("_crc expected: %d", header->crc());
1237 log_info(cds)(" actual: %d", actual_crc);
1238 log_warning(cds)("Header checksum verification failed.");
1239 return false;
1240 }
1241 }
1242 return true;
1243 }
1244
1245 bool check_and_init_base_archive_name() {
1246 unsigned int name_offset = _header->_base_archive_name_offset;
1247 unsigned int name_size = _header->_base_archive_name_size;
1248 unsigned int header_size = _header->_header_size;
1249
1250 if (name_offset + name_size < name_offset) {
1251 log_warning(cds)("base_archive_name offset/size overflow: " UINT32_FORMAT "/" UINT32_FORMAT,
1252 name_offset, name_size);
1253 return false;
1254 }
1255 if (_header->_magic == CDS_ARCHIVE_MAGIC) {
1256 if (name_offset != 0) {
1257 log_warning(cds)("static shared archive must have zero _base_archive_name_offset");
1258 return false;
1259 }
1260 if (name_size != 0) {
1261 log_warning(cds)("static shared archive must have zero _base_archive_name_size");
1262 return false;
1263 }
1264 } else {
1265 assert(_header->_magic == CDS_DYNAMIC_ARCHIVE_MAGIC, "must be");
1266 if ((name_size == 0 && name_offset != 0) ||
1267 (name_size != 0 && name_offset == 0)) {
1268 // If either is zero, both must be zero. This indicates that we are using the default base archive.
1269 log_warning(cds)("Invalid base_archive_name offset/size: " UINT32_FORMAT "/" UINT32_FORMAT,
1270 name_offset, name_size);
1271 return false;
1272 }
1273 if (name_size > 0) {
1274 if (name_offset + name_size > header_size) {
1275 log_warning(cds)("Invalid base_archive_name offset/size (out of range): "
1276 UINT32_FORMAT " + " UINT32_FORMAT " > " UINT32_FORMAT ,
1277 name_offset, name_size, header_size);
1278 return false;
1279 }
1280 const char* name = ((const char*)_header) + _header->_base_archive_name_offset;
1281 if (name[name_size - 1] != '\0' || strlen(name) != name_size - 1) {
1282 log_warning(cds)("Base archive name is damaged");
1283 return false;
1284 }
1285 if (!os::file_exists(name)) {
1286 log_warning(cds)("Base archive %s does not exist", name);
1287 return false;
1288 }
1289 _base_archive_name = name;
1290 }
1291 }
1292
1293 return true;
1294 }
1295 };
1296
1297 // Return value:
1298 // false:
1299 // <archive_name> is not a valid archive. *base_archive_name is set to null.
1300 // true && (*base_archive_name) == nullptr:
1301 // <archive_name> is a valid static archive.
1302 // true && (*base_archive_name) != nullptr:
1303 // <archive_name> is a valid dynamic archive.
1304 bool FileMapInfo::get_base_archive_name_from_header(const char* archive_name,
1305 char** base_archive_name) {
1306 FileHeaderHelper file_helper(archive_name, false);
1307 *base_archive_name = nullptr;
1308
1309 if (!file_helper.initialize()) {
1310 return false;
1311 }
1312 GenericCDSFileMapHeader* header = file_helper.get_generic_file_header();
1313 if (header->_magic != CDS_DYNAMIC_ARCHIVE_MAGIC) {
1314 assert(header->_magic == CDS_ARCHIVE_MAGIC, "must be");
1315 if (AutoCreateSharedArchive) {
1316 log_warning(cds)("AutoCreateSharedArchive is ignored because %s is a static archive", archive_name);
1317 }
1318 return true;
1319 }
1320
1321 const char* base = file_helper.base_archive_name();
1322 if (base == nullptr) {
1323 *base_archive_name = CDSConfig::default_archive_path();
1324 } else {
1325 *base_archive_name = os::strdup_check_oom(base);
1326 }
1327
1328 return true;
1329 }
1330
1331 // Read the FileMapInfo information from the file.
1332
1333 bool FileMapInfo::init_from_file(int fd) {
1334 FileHeaderHelper file_helper(_full_path, _is_static);
1335 if (!file_helper.initialize(fd)) {
1336 log_warning(cds)("Unable to read the file header.");
1337 return false;
1338 }
1339 GenericCDSFileMapHeader* gen_header = file_helper.get_generic_file_header();
1340
1341 if (_is_static) {
1342 if (gen_header->_magic != CDS_ARCHIVE_MAGIC) {
1343 log_warning(cds)("Not a base shared archive: %s", _full_path);
1344 return false;
1345 }
1346 } else {
1347 if (gen_header->_magic != CDS_DYNAMIC_ARCHIVE_MAGIC) {
1348 log_warning(cds)("Not a top shared archive: %s", _full_path);
1349 return false;
1350 }
1351 }
1352
1353 _header = (FileMapHeader*)os::malloc(gen_header->_header_size, mtInternal);
1354 os::lseek(fd, 0, SEEK_SET); // reset to begin of the archive
1355 size_t size = gen_header->_header_size;
1356 size_t n = ::read(fd, (void*)_header, (unsigned int)size);
1357 if (n != size) {
1358 log_warning(cds)("Failed to read file header from the top archive file\n");
1359 return false;
1360 }
1361
1362 if (header()->version() != CURRENT_CDS_ARCHIVE_VERSION) {
1363 log_info(cds)("_version expected: 0x%x", CURRENT_CDS_ARCHIVE_VERSION);
1364 log_info(cds)(" actual: 0x%x", header()->version());
1365 log_warning(cds)("The shared archive file has the wrong version.");
1366 return false;
1367 }
1368
1369 int common_path_size = header()->common_app_classpath_prefix_size();
1370 if (common_path_size < 0) {
1371 log_warning(cds)("common app classpath prefix len < 0");
1372 return false;
1373 }
1374
1375 unsigned int base_offset = header()->base_archive_name_offset();
1376 unsigned int name_size = header()->base_archive_name_size();
1377 unsigned int header_size = header()->header_size();
1378 if (base_offset != 0 && name_size != 0) {
1379 if (header_size != base_offset + name_size) {
1380 log_info(cds)("_header_size: " UINT32_FORMAT, header_size);
1381 log_info(cds)("common_app_classpath_size: " UINT32_FORMAT, header()->common_app_classpath_prefix_size());
1382 log_info(cds)("base_archive_name_size: " UINT32_FORMAT, header()->base_archive_name_size());
1383 log_info(cds)("base_archive_name_offset: " UINT32_FORMAT, header()->base_archive_name_offset());
1384 log_warning(cds)("The shared archive file has an incorrect header size.");
1385 return false;
1386 }
1387 }
1388
1389 const char* actual_ident = header()->jvm_ident();
1390
1391 if (actual_ident[JVM_IDENT_MAX-1] != 0) {
1392 log_warning(cds)("JVM version identifier is corrupted.");
1393 return false;
1394 }
1395
1396 char expected_ident[JVM_IDENT_MAX];
1397 get_header_version(expected_ident);
1398 if (strncmp(actual_ident, expected_ident, JVM_IDENT_MAX-1) != 0) {
1399 log_info(cds)("_jvm_ident expected: %s", expected_ident);
1400 log_info(cds)(" actual: %s", actual_ident);
1401 log_warning(cds)("The shared archive file was created by a different"
1402 " version or build of HotSpot");
1403 return false;
1404 }
1405
1406 _file_offset = header()->header_size(); // accounts for the size of _base_archive_name
1407
1408 size_t len = os::lseek(fd, 0, SEEK_END);
1409
1410 for (int i = 0; i < MetaspaceShared::n_regions; i++) {
1411 FileMapRegion* r = region_at(i);
1412 if (r->file_offset() > len || len - r->file_offset() < r->used()) {
1413 log_warning(cds)("The shared archive file has been truncated.");
1414 return false;
1415 }
1416 }
1417
1418 if (!header()->check_must_match_flags()) {
1419 return false;
1420 }
1421
1422 return true;
1423 }
1424
1425 void FileMapInfo::seek_to_position(size_t pos) {
1426 if (os::lseek(_fd, (long)pos, SEEK_SET) < 0) {
1427 log_error(cds)("Unable to seek to position " SIZE_FORMAT, pos);
1428 MetaspaceShared::unrecoverable_loading_error();
1429 }
1430 }
1431
1432 // Read the FileMapInfo information from the file.
1433 bool FileMapInfo::open_for_read() {
1434 if (_file_open) {
1435 return true;
1436 }
1437 log_info(cds)("trying to map %s", _full_path);
1438 int fd = os::open(_full_path, O_RDONLY | O_BINARY, 0);
1439 if (fd < 0) {
1440 if (errno == ENOENT) {
1441 log_info(cds)("Specified shared archive not found (%s)", _full_path);
1442 } else {
1443 log_warning(cds)("Failed to open shared archive file (%s)",
1444 os::strerror(errno));
1445 }
1446 return false;
1447 } else {
1448 log_info(cds)("Opened archive %s.", _full_path);
1449 }
1450
1451 _fd = fd;
1452 _file_open = true;
1453 return true;
1454 }
1455
1456 // Write the FileMapInfo information to the file.
1457
1458 void FileMapInfo::open_for_write() {
1459 LogMessage(cds) msg;
1460 if (msg.is_info()) {
1461 msg.info("Dumping shared data to file: ");
1462 msg.info(" %s", _full_path);
1463 }
1464
1465 #ifdef _WINDOWS // On Windows, need WRITE permission to remove the file.
1466 chmod(_full_path, _S_IREAD | _S_IWRITE);
1467 #endif
1468
1469 // Use remove() to delete the existing file because, on Unix, this will
1470 // allow processes that have it open continued access to the file.
1471 remove(_full_path);
1472 int fd = os::open(_full_path, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0444);
1473 if (fd < 0) {
1474 log_error(cds)("Unable to create shared archive file %s: (%s).", _full_path,
1475 os::strerror(errno));
1476 MetaspaceShared::unrecoverable_writing_error();
1477 }
1478 _fd = fd;
1479 _file_open = true;
1480
1481 // Seek past the header. We will write the header after all regions are written
1482 // and their CRCs computed.
1483 size_t header_bytes = header()->header_size();
1484
1485 header_bytes = align_up(header_bytes, MetaspaceShared::core_region_alignment());
1486 _file_offset = header_bytes;
1487 seek_to_position(_file_offset);
1488 }
1489
1490 // Write the header to the file, seek to the next allocation boundary.
1491
1492 void FileMapInfo::write_header() {
1493 _file_offset = 0;
1494 seek_to_position(_file_offset);
1495 assert(is_file_position_aligned(), "must be");
1496 write_bytes(header(), header()->header_size());
1497 }
1498
1499 size_t FileMapRegion::used_aligned() const {
1500 return align_up(used(), MetaspaceShared::core_region_alignment());
1501 }
1502
1503 void FileMapRegion::init(int region_index, size_t mapping_offset, size_t size, bool read_only,
1504 bool allow_exec, int crc) {
1505 _is_heap_region = HeapShared::is_heap_region(region_index);
1506 _is_bitmap_region = (region_index == MetaspaceShared::bm);
1507 _mapping_offset = mapping_offset;
1508 _used = size;
1509 _read_only = read_only;
1510 _allow_exec = allow_exec;
1511 _crc = crc;
1512 _mapped_from_file = false;
1513 _mapped_base = nullptr;
1514 }
1515
1516 void FileMapRegion::init_oopmap(size_t offset, size_t size_in_bits) {
1517 _oopmap_offset = offset;
1518 _oopmap_size_in_bits = size_in_bits;
1519 }
1520
1521 void FileMapRegion::init_ptrmap(size_t offset, size_t size_in_bits) {
1522 _ptrmap_offset = offset;
1523 _ptrmap_size_in_bits = size_in_bits;
1524 }
1525
1526 BitMapView FileMapRegion::bitmap_view(bool is_oopmap) {
1527 char* bitmap_base = FileMapInfo::current_info()->map_bitmap_region();
1528 bitmap_base += is_oopmap ? _oopmap_offset : _ptrmap_offset;
1529 size_t size_in_bits = is_oopmap ? _oopmap_size_in_bits : _ptrmap_size_in_bits;
1530 return BitMapView((BitMap::bm_word_t*)(bitmap_base), size_in_bits);
1531 }
1532
1533 BitMapView FileMapRegion::oopmap_view() {
1534 return bitmap_view(true);
1535 }
1536
1537 BitMapView FileMapRegion::ptrmap_view() {
1538 assert(has_ptrmap(), "must be");
1539 return bitmap_view(false);
1540 }
1541
1542 bool FileMapRegion::check_region_crc(char* base) const {
1543 // This function should be called after the region has been properly
1544 // loaded into memory via FileMapInfo::map_region() or FileMapInfo::read_region().
1545 // I.e., this->mapped_base() must be valid.
1546 size_t sz = used();
1547 if (sz == 0) {
1548 return true;
1549 }
1550
1551 assert(base != nullptr, "must be initialized");
1552 int crc = ClassLoader::crc32(0, base, (jint)sz);
1553 if (crc != this->crc()) {
1554 log_warning(cds)("Checksum verification failed.");
1555 return false;
1556 }
1557 return true;
1558 }
1559
1560 static const char* region_name(int region_index) {
1561 static const char* names[] = {
1562 "rw", "ro", "bm", "hp"
1563 };
1564 const int num_regions = sizeof(names)/sizeof(names[0]);
1565 assert(0 <= region_index && region_index < num_regions, "sanity");
1566
1567 return names[region_index];
1568 }
1569
1570 void FileMapRegion::print(outputStream* st, int region_index) {
1571 st->print_cr("============ region ============= %d \"%s\"", region_index, region_name(region_index));
1572 st->print_cr("- crc: 0x%08x", _crc);
1573 st->print_cr("- read_only: %d", _read_only);
1574 st->print_cr("- allow_exec: %d", _allow_exec);
1575 st->print_cr("- is_heap_region: %d", _is_heap_region);
1576 st->print_cr("- is_bitmap_region: %d", _is_bitmap_region);
1577 st->print_cr("- mapped_from_file: %d", _mapped_from_file);
1578 st->print_cr("- file_offset: " SIZE_FORMAT_X, _file_offset);
1579 st->print_cr("- mapping_offset: " SIZE_FORMAT_X, _mapping_offset);
1580 st->print_cr("- used: " SIZE_FORMAT, _used);
1581 st->print_cr("- oopmap_offset: " SIZE_FORMAT_X, _oopmap_offset);
1582 st->print_cr("- oopmap_size_in_bits: " SIZE_FORMAT, _oopmap_size_in_bits);
1583 st->print_cr("- mapped_base: " INTPTR_FORMAT, p2i(_mapped_base));
1584 }
1585
1586 void FileMapInfo::write_region(int region, char* base, size_t size,
1587 bool read_only, bool allow_exec) {
1588 assert(CDSConfig::is_dumping_archive(), "sanity");
1589
1590 FileMapRegion* r = region_at(region);
1591 char* requested_base;
1592 size_t mapping_offset = 0;
1593
1594 if (region == MetaspaceShared::bm) {
1595 requested_base = nullptr; // always null for bm region
1596 } else if (size == 0) {
1597 // This is an unused region (e.g., a heap region when !INCLUDE_CDS_JAVA_HEAP)
1598 requested_base = nullptr;
1599 } else if (HeapShared::is_heap_region(region)) {
1600 assert(HeapShared::can_write(), "sanity");
1601 #if INCLUDE_CDS_JAVA_HEAP
1602 assert(!CDSConfig::is_dumping_dynamic_archive(), "must be");
1603 requested_base = (char*)ArchiveHeapWriter::requested_address();
1604 if (UseCompressedOops) {
1605 mapping_offset = (size_t)((address)requested_base - CompressedOops::base());
1606 assert((mapping_offset >> CompressedOops::shift()) << CompressedOops::shift() == mapping_offset, "must be");
1607 } else {
1608 mapping_offset = 0; // not used with !UseCompressedOops
1609 }
1610 #endif // INCLUDE_CDS_JAVA_HEAP
1611 } else {
1612 char* requested_SharedBaseAddress = (char*)MetaspaceShared::requested_base_address();
1613 requested_base = ArchiveBuilder::current()->to_requested(base);
1614 assert(requested_base >= requested_SharedBaseAddress, "must be");
1615 mapping_offset = requested_base - requested_SharedBaseAddress;
1616 }
1617
1618 r->set_file_offset(_file_offset);
1619 int crc = ClassLoader::crc32(0, base, (jint)size);
1620 if (size > 0) {
1621 log_info(cds)("Shared file region (%s) %d: " SIZE_FORMAT_W(8)
1622 " bytes, addr " INTPTR_FORMAT " file offset 0x%08" PRIxPTR
1623 " crc 0x%08x",
1624 region_name(region), region, size, p2i(requested_base), _file_offset, crc);
1625 }
1626
1627 r->init(region, mapping_offset, size, read_only, allow_exec, crc);
1628
1629 if (base != nullptr) {
1630 write_bytes_aligned(base, size);
1631 }
1632 }
1633
1634 static size_t write_bitmap(const CHeapBitMap* map, char* output, size_t offset) {
1635 size_t size_in_bytes = map->size_in_bytes();
1636 map->write_to((BitMap::bm_word_t*)(output + offset), size_in_bytes);
1637 return offset + size_in_bytes;
1638 }
1639
1640 char* FileMapInfo::write_bitmap_region(const CHeapBitMap* ptrmap, ArchiveHeapInfo* heap_info,
1641 size_t &size_in_bytes) {
1642 size_in_bytes = ptrmap->size_in_bytes();
1643
1644 if (heap_info->is_used()) {
1645 size_in_bytes += heap_info->oopmap()->size_in_bytes();
1646 size_in_bytes += heap_info->ptrmap()->size_in_bytes();
1647 }
1648
1649 // The bitmap region contains up to 3 parts:
1650 // ptrmap: metaspace pointers inside the ro/rw regions
1651 // heap_info->oopmap(): Java oop pointers in the heap region
1652 // heap_info->ptrmap(): metaspace pointers in the heap region
1653 char* buffer = NEW_C_HEAP_ARRAY(char, size_in_bytes, mtClassShared);
1654 size_t written = 0;
1655 written = write_bitmap(ptrmap, buffer, written);
1656 header()->set_ptrmap_size_in_bits(ptrmap->size());
1657
1658 if (heap_info->is_used()) {
1659 FileMapRegion* r = region_at(MetaspaceShared::hp);
1660
1661 r->init_oopmap(written, heap_info->oopmap()->size());
1662 written = write_bitmap(heap_info->oopmap(), buffer, written);
1663
1664 r->init_ptrmap(written, heap_info->ptrmap()->size());
1665 written = write_bitmap(heap_info->ptrmap(), buffer, written);
1666 }
1667
1668 write_region(MetaspaceShared::bm, (char*)buffer, size_in_bytes, /*read_only=*/true, /*allow_exec=*/false);
1669 return buffer;
1670 }
1671
1672 size_t FileMapInfo::write_heap_region(ArchiveHeapInfo* heap_info) {
1673 char* buffer_start = heap_info->buffer_start();
1674 size_t buffer_size = heap_info->buffer_byte_size();
1675 write_region(MetaspaceShared::hp, buffer_start, buffer_size, false, false);
1676 header()->set_heap_roots_offset(heap_info->heap_roots_offset());
1677 return buffer_size;
1678 }
1679
1680 // Dump bytes to file -- at the current file position.
1681
1682 void FileMapInfo::write_bytes(const void* buffer, size_t nbytes) {
1683 assert(_file_open, "must be");
1684 if (!os::write(_fd, buffer, nbytes)) {
1685 // If the shared archive is corrupted, close it and remove it.
1686 close();
1687 remove(_full_path);
1688 MetaspaceShared::unrecoverable_writing_error("Unable to write to shared archive file.");
1689 }
1690 _file_offset += nbytes;
1691 }
1692
1693 bool FileMapInfo::is_file_position_aligned() const {
1694 return _file_offset == align_up(_file_offset,
1695 MetaspaceShared::core_region_alignment());
1696 }
1697
1698 // Align file position to an allocation unit boundary.
1699
1700 void FileMapInfo::align_file_position() {
1701 assert(_file_open, "must be");
1702 size_t new_file_offset = align_up(_file_offset,
1703 MetaspaceShared::core_region_alignment());
1704 if (new_file_offset != _file_offset) {
1705 _file_offset = new_file_offset;
1706 // Seek one byte back from the target and write a byte to insure
1707 // that the written file is the correct length.
1708 _file_offset -= 1;
1709 seek_to_position(_file_offset);
1710 char zero = 0;
1711 write_bytes(&zero, 1);
1712 }
1713 }
1714
1715
1716 // Dump bytes to file -- at the current file position.
1717
1718 void FileMapInfo::write_bytes_aligned(const void* buffer, size_t nbytes) {
1719 align_file_position();
1720 write_bytes(buffer, nbytes);
1721 align_file_position();
1722 }
1723
1724 // Close the shared archive file. This does NOT unmap mapped regions.
1725
1726 void FileMapInfo::close() {
1727 if (_file_open) {
1728 if (::close(_fd) < 0) {
1729 MetaspaceShared::unrecoverable_loading_error("Unable to close the shared archive file.");
1730 }
1731 _file_open = false;
1732 _fd = -1;
1733 }
1734 }
1735
1736 /*
1737 * Same as os::map_memory() but also pretouches if AlwaysPreTouch is enabled.
1738 */
1739 static char* map_memory(int fd, const char* file_name, size_t file_offset,
1740 char *addr, size_t bytes, bool read_only,
1741 bool allow_exec, MEMFLAGS flags = mtNone) {
1742 char* mem = os::map_memory(fd, file_name, file_offset, addr, bytes,
1743 AlwaysPreTouch ? false : read_only,
1744 allow_exec, flags);
1745 if (mem != nullptr && AlwaysPreTouch) {
1746 os::pretouch_memory(mem, mem + bytes);
1747 }
1748 return mem;
1749 }
1750
1751 // JVM/TI RedefineClasses() support:
1752 // Remap the shared readonly space to shared readwrite, private.
1753 bool FileMapInfo::remap_shared_readonly_as_readwrite() {
1754 int idx = MetaspaceShared::ro;
1755 FileMapRegion* r = region_at(idx);
1756 if (!r->read_only()) {
1757 // the space is already readwrite so we are done
1758 return true;
1759 }
1760 size_t size = r->used_aligned();
1761 if (!open_for_read()) {
1762 return false;
1763 }
1764 char *addr = r->mapped_base();
1765 char *base = os::remap_memory(_fd, _full_path, r->file_offset(),
1766 addr, size, false /* !read_only */,
1767 r->allow_exec());
1768 close();
1769 // These have to be errors because the shared region is now unmapped.
1770 if (base == nullptr) {
1771 log_error(cds)("Unable to remap shared readonly space (errno=%d).", errno);
1772 vm_exit(1);
1773 }
1774 if (base != addr) {
1775 log_error(cds)("Unable to remap shared readonly space (errno=%d).", errno);
1776 vm_exit(1);
1777 }
1778 r->set_read_only(false);
1779 return true;
1780 }
1781
1782 // Memory map a region in the address space.
1783 static const char* shared_region_name[] = { "ReadWrite", "ReadOnly", "Bitmap", "Heap" };
1784
1785 MapArchiveResult FileMapInfo::map_regions(int regions[], int num_regions, char* mapped_base_address, ReservedSpace rs) {
1786 DEBUG_ONLY(FileMapRegion* last_region = nullptr);
1787 intx addr_delta = mapped_base_address - header()->requested_base_address();
1788
1789 // Make sure we don't attempt to use header()->mapped_base_address() unless
1790 // it's been successfully mapped.
1791 DEBUG_ONLY(header()->set_mapped_base_address((char*)(uintptr_t)0xdeadbeef);)
1792
1793 for (int i = 0; i < num_regions; i++) {
1794 int idx = regions[i];
1795 MapArchiveResult result = map_region(idx, addr_delta, mapped_base_address, rs);
1796 if (result != MAP_ARCHIVE_SUCCESS) {
1797 return result;
1798 }
1799 FileMapRegion* r = region_at(idx);
1800 DEBUG_ONLY(if (last_region != nullptr) {
1801 // Ensure that the OS won't be able to allocate new memory spaces between any mapped
1802 // regions, or else it would mess up the simple comparison in MetaspaceObj::is_shared().
1803 assert(r->mapped_base() == last_region->mapped_end(), "must have no gaps");
1804 }
1805 last_region = r;)
1806 log_info(cds)("Mapped %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)", is_static() ? "static " : "dynamic",
1807 idx, p2i(r->mapped_base()), p2i(r->mapped_end()),
1808 shared_region_name[idx]);
1809
1810 }
1811
1812 header()->set_mapped_base_address(header()->requested_base_address() + addr_delta);
1813 if (addr_delta != 0 && !relocate_pointers_in_core_regions(addr_delta)) {
1814 return MAP_ARCHIVE_OTHER_FAILURE;
1815 }
1816
1817 return MAP_ARCHIVE_SUCCESS;
1818 }
1819
1820 bool FileMapInfo::read_region(int i, char* base, size_t size, bool do_commit) {
1821 FileMapRegion* r = region_at(i);
1822 if (do_commit) {
1823 log_info(cds)("Commit %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)%s",
1824 is_static() ? "static " : "dynamic", i, p2i(base), p2i(base + size),
1825 shared_region_name[i], r->allow_exec() ? " exec" : "");
1826 if (!os::commit_memory(base, size, r->allow_exec())) {
1827 log_error(cds)("Failed to commit %s region #%d (%s)", is_static() ? "static " : "dynamic",
1828 i, shared_region_name[i]);
1829 return false;
1830 }
1831 }
1832 if (os::lseek(_fd, (long)r->file_offset(), SEEK_SET) != (int)r->file_offset() ||
1833 read_bytes(base, size) != size) {
1834 return false;
1835 }
1836
1837 if (VerifySharedSpaces && !r->check_region_crc(base)) {
1838 return false;
1839 }
1840
1841 r->set_mapped_from_file(false);
1842 r->set_mapped_base(base);
1843
1844 return true;
1845 }
1846
1847 MapArchiveResult FileMapInfo::map_region(int i, intx addr_delta, char* mapped_base_address, ReservedSpace rs) {
1848 assert(!HeapShared::is_heap_region(i), "sanity");
1849 FileMapRegion* r = region_at(i);
1850 size_t size = r->used_aligned();
1851 char *requested_addr = mapped_base_address + r->mapping_offset();
1852 assert(r->mapped_base() == nullptr, "must be not mapped yet");
1853 assert(requested_addr != nullptr, "must be specified");
1854
1855 r->set_mapped_from_file(false);
1856
1857 if (MetaspaceShared::use_windows_memory_mapping()) {
1858 // Windows cannot remap read-only shared memory to read-write when required for
1859 // RedefineClasses, which is also used by JFR. Always map windows regions as RW.
1860 r->set_read_only(false);
1861 } else if (JvmtiExport::can_modify_any_class() || JvmtiExport::can_walk_any_space() ||
1862 Arguments::has_jfr_option()) {
1863 // If a tool agent is in use (debugging enabled), or JFR, we must map the address space RW
1864 r->set_read_only(false);
1865 } else if (addr_delta != 0) {
1866 r->set_read_only(false); // Need to patch the pointers
1867 }
1868
1869 if (MetaspaceShared::use_windows_memory_mapping() && rs.is_reserved()) {
1870 // This is the second time we try to map the archive(s). We have already created a ReservedSpace
1871 // that covers all the FileMapRegions to ensure all regions can be mapped. However, Windows
1872 // can't mmap into a ReservedSpace, so we just ::read() the data. We're going to patch all the
1873 // regions anyway, so there's no benefit for mmap anyway.
1874 if (!read_region(i, requested_addr, size, /* do_commit = */ true)) {
1875 log_info(cds)("Failed to read %s shared space into reserved space at " INTPTR_FORMAT,
1876 shared_region_name[i], p2i(requested_addr));
1877 return MAP_ARCHIVE_OTHER_FAILURE; // oom or I/O error.
1878 } else {
1879 assert(r->mapped_base() != nullptr, "must be initialized");
1880 return MAP_ARCHIVE_SUCCESS;
1881 }
1882 } else {
1883 // Note that this may either be a "fresh" mapping into unreserved address
1884 // space (Windows, first mapping attempt), or a mapping into pre-reserved
1885 // space (Posix). See also comment in MetaspaceShared::map_archives().
1886 char* base = map_memory(_fd, _full_path, r->file_offset(),
1887 requested_addr, size, r->read_only(),
1888 r->allow_exec(), mtClassShared);
1889 if (base != requested_addr) {
1890 log_info(cds)("Unable to map %s shared space at " INTPTR_FORMAT,
1891 shared_region_name[i], p2i(requested_addr));
1892 _memory_mapping_failed = true;
1893 return MAP_ARCHIVE_MMAP_FAILURE;
1894 }
1895
1896 if (VerifySharedSpaces && !r->check_region_crc(requested_addr)) {
1897 return MAP_ARCHIVE_OTHER_FAILURE;
1898 }
1899
1900 r->set_mapped_from_file(true);
1901 r->set_mapped_base(requested_addr);
1902
1903 return MAP_ARCHIVE_SUCCESS;
1904 }
1905 }
1906
1907 // The return value is the location of the archive relocation bitmap.
1908 char* FileMapInfo::map_bitmap_region() {
1909 FileMapRegion* r = region_at(MetaspaceShared::bm);
1910 if (r->mapped_base() != nullptr) {
1911 return r->mapped_base();
1912 }
1913 bool read_only = true, allow_exec = false;
1914 char* requested_addr = nullptr; // allow OS to pick any location
1915 char* bitmap_base = map_memory(_fd, _full_path, r->file_offset(),
1916 requested_addr, r->used_aligned(), read_only, allow_exec, mtClassShared);
1917 if (bitmap_base == nullptr) {
1918 log_info(cds)("failed to map relocation bitmap");
1919 return nullptr;
1920 }
1921
1922 if (VerifySharedSpaces && !r->check_region_crc(bitmap_base)) {
1923 log_error(cds)("relocation bitmap CRC error");
1924 if (!os::unmap_memory(bitmap_base, r->used_aligned())) {
1925 fatal("os::unmap_memory of relocation bitmap failed");
1926 }
1927 return nullptr;
1928 }
1929
1930 r->set_mapped_from_file(true);
1931 r->set_mapped_base(bitmap_base);
1932 log_info(cds)("Mapped %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)",
1933 is_static() ? "static " : "dynamic",
1934 MetaspaceShared::bm, p2i(r->mapped_base()), p2i(r->mapped_end()),
1935 shared_region_name[MetaspaceShared::bm]);
1936 return bitmap_base;
1937 }
1938
1939 // This is called when we cannot map the archive at the requested[ base address (usually 0x800000000).
1940 // We relocate all pointers in the 2 core regions (ro, rw).
1941 bool FileMapInfo::relocate_pointers_in_core_regions(intx addr_delta) {
1942 log_debug(cds, reloc)("runtime archive relocation start");
1943 char* bitmap_base = map_bitmap_region();
1944
1945 if (bitmap_base == nullptr) {
1946 return false; // OOM, or CRC check failure
1947 } else {
1948 size_t ptrmap_size_in_bits = header()->ptrmap_size_in_bits();
1949 log_debug(cds, reloc)("mapped relocation bitmap @ " INTPTR_FORMAT " (" SIZE_FORMAT " bits)",
1950 p2i(bitmap_base), ptrmap_size_in_bits);
1951
1952 BitMapView ptrmap((BitMap::bm_word_t*)bitmap_base, ptrmap_size_in_bits);
1953
1954 // Patch all pointers in the mapped region that are marked by ptrmap.
1955 address patch_base = (address)mapped_base();
1956 address patch_end = (address)mapped_end();
1957
1958 // the current value of the pointers to be patched must be within this
1959 // range (i.e., must be between the requested base address and the address of the current archive).
1960 // Note: top archive may point to objects in the base archive, but not the other way around.
1961 address valid_old_base = (address)header()->requested_base_address();
1962 address valid_old_end = valid_old_base + mapping_end_offset();
1963
1964 // after patching, the pointers must point inside this range
1965 // (the requested location of the archive, as mapped at runtime).
1966 address valid_new_base = (address)header()->mapped_base_address();
1967 address valid_new_end = (address)mapped_end();
1968
1969 SharedDataRelocator patcher((address*)patch_base, (address*)patch_end, valid_old_base, valid_old_end,
1970 valid_new_base, valid_new_end, addr_delta);
1971 ptrmap.iterate(&patcher);
1972
1973 // The MetaspaceShared::bm region will be unmapped in MetaspaceShared::initialize_shared_spaces().
1974
1975 log_debug(cds, reloc)("runtime archive relocation done");
1976 return true;
1977 }
1978 }
1979
1980 size_t FileMapInfo::read_bytes(void* buffer, size_t count) {
1981 assert(_file_open, "Archive file is not open");
1982 size_t n = ::read(_fd, buffer, (unsigned int)count);
1983 if (n != count) {
1984 // Close the file if there's a problem reading it.
1985 close();
1986 return 0;
1987 }
1988 _file_offset += count;
1989 return count;
1990 }
1991
1992 // Get the total size in bytes of a read only region
1993 size_t FileMapInfo::readonly_total() {
1994 size_t total = 0;
1995 if (current_info() != nullptr) {
1996 FileMapRegion* r = FileMapInfo::current_info()->region_at(MetaspaceShared::ro);
1997 if (r->read_only()) total += r->used();
1998 }
1999 if (dynamic_info() != nullptr) {
2000 FileMapRegion* r = FileMapInfo::dynamic_info()->region_at(MetaspaceShared::ro);
2001 if (r->read_only()) total += r->used();
2002 }
2003 return total;
2004 }
2005
2006 #if INCLUDE_CDS_JAVA_HEAP
2007 MemRegion FileMapInfo::_mapped_heap_memregion;
2008
2009 bool FileMapInfo::has_heap_region() {
2010 return (region_at(MetaspaceShared::hp)->used() > 0);
2011 }
2012
2013 // Returns the address range of the archived heap region computed using the
2014 // current oop encoding mode. This range may be different than the one seen at
2015 // dump time due to encoding mode differences. The result is used in determining
2016 // if/how these regions should be relocated at run time.
2017 MemRegion FileMapInfo::get_heap_region_requested_range() {
2018 FileMapRegion* r = region_at(MetaspaceShared::hp);
2019 size_t size = r->used();
2020 assert(size > 0, "must have non-empty heap region");
2021
2022 address start = heap_region_requested_address();
2023 address end = start + size;
2024 log_info(cds)("Requested heap region [" INTPTR_FORMAT " - " INTPTR_FORMAT "] = " SIZE_FORMAT_W(8) " bytes",
2025 p2i(start), p2i(end), size);
2026
2027 return MemRegion((HeapWord*)start, (HeapWord*)end);
2028 }
2029
2030 void FileMapInfo::map_or_load_heap_region() {
2031 bool success = false;
2032
2033 if (can_use_heap_region()) {
2034 if (ArchiveHeapLoader::can_map()) {
2035 success = map_heap_region();
2036 } else if (ArchiveHeapLoader::can_load()) {
2037 success = ArchiveHeapLoader::load_heap_region(this);
2038 } else {
2039 if (!UseCompressedOops && !ArchiveHeapLoader::can_map()) {
2040 // TODO - remove implicit knowledge of G1
2041 log_info(cds)("Cannot use CDS heap data. UseG1GC is required for -XX:-UseCompressedOops");
2042 } else {
2043 log_info(cds)("Cannot use CDS heap data. UseEpsilonGC, UseG1GC, UseSerialGC or UseParallelGC are required.");
2044 }
2045 }
2046 }
2047
2048 if (!success) {
2049 CDSConfig::disable_loading_full_module_graph();
2050 }
2051 }
2052
2053 bool FileMapInfo::can_use_heap_region() {
2054 if (!has_heap_region()) {
2055 return false;
2056 }
2057 if (JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()) {
2058 ShouldNotReachHere(); // CDS should have been disabled.
2059 // The archived objects are mapped at JVM start-up, but we don't know if
2060 // j.l.String or j.l.Class might be replaced by the ClassFileLoadHook,
2061 // which would make the archived String or mirror objects invalid. Let's be safe and not
2062 // use the archived objects. These 2 classes are loaded during the JVMTI "early" stage.
2063 //
2064 // If JvmtiExport::has_early_class_hook_env() is false, the classes of some objects
2065 // in the archived subgraphs may be replaced by the ClassFileLoadHook. But that's OK
2066 // because we won't install an archived object subgraph if the klass of any of the
2067 // referenced objects are replaced. See HeapShared::initialize_from_archived_subgraph().
2068 }
2069
2070 // We pre-compute narrow Klass IDs with the runtime mapping start intended to be the base, and a shift of
2071 // ArchiveHeapWriter::precomputed_narrow_klass_shift. We enforce this encoding at runtime (see
2072 // CompressedKlassPointers::initialize_for_given_encoding()). Therefore, the following assertions must
2073 // hold:
2074 address archive_narrow_klass_base = (address)header()->mapped_base_address();
2075 const int archive_narrow_klass_shift = ArchiveHeapWriter::precomputed_narrow_klass_shift;
2076
2077 log_info(cds)("CDS archive was created with max heap size = " SIZE_FORMAT "M, and the following configuration:",
2078 max_heap_size()/M);
2079 log_info(cds)(" narrow_klass_base at mapping start address, narrow_klass_shift = %d",
2080 archive_narrow_klass_shift);
2081 log_info(cds)(" narrow_oop_mode = %d, narrow_oop_base = " PTR_FORMAT ", narrow_oop_shift = %d",
2082 narrow_oop_mode(), p2i(narrow_oop_base()), narrow_oop_shift());
2083 log_info(cds)("The current max heap size = " SIZE_FORMAT "M, HeapRegion::GrainBytes = " SIZE_FORMAT,
2084 MaxHeapSize/M, HeapRegion::GrainBytes);
2085 log_info(cds)(" narrow_klass_base = " PTR_FORMAT ", narrow_klass_shift = %d",
2086 p2i(CompressedKlassPointers::base()), CompressedKlassPointers::shift());
2087 log_info(cds)(" narrow_oop_mode = %d, narrow_oop_base = " PTR_FORMAT ", narrow_oop_shift = %d",
2088 CompressedOops::mode(), p2i(CompressedOops::base()), CompressedOops::shift());
2089 log_info(cds)(" heap range = [" PTR_FORMAT " - " PTR_FORMAT "]",
2090 UseCompressedOops ? p2i(CompressedOops::begin()) :
2091 UseG1GC ? p2i((address)G1CollectedHeap::heap()->reserved().start()) : 0L,
2092 UseCompressedOops ? p2i(CompressedOops::end()) :
2093 UseG1GC ? p2i((address)G1CollectedHeap::heap()->reserved().end()) : 0L);
2094
2095 assert(archive_narrow_klass_base == CompressedKlassPointers::base(), "Unexpected encoding base encountered "
2096 "(" PTR_FORMAT ", expected " PTR_FORMAT ")", p2i(CompressedKlassPointers::base()), p2i(archive_narrow_klass_base));
2097 assert(archive_narrow_klass_shift == CompressedKlassPointers::shift(), "Unexpected encoding shift encountered "
2098 "(%d, expected %d)", CompressedKlassPointers::shift(), archive_narrow_klass_shift);
2099
2100 return true;
2101 }
2102
2103 // The actual address of this region during dump time.
2104 address FileMapInfo::heap_region_dumptime_address() {
2105 FileMapRegion* r = region_at(MetaspaceShared::hp);
2106 assert(UseSharedSpaces, "runtime only");
2107 assert(is_aligned(r->mapping_offset(), sizeof(HeapWord)), "must be");
2108 if (UseCompressedOops) {
2109 return /*dumptime*/ narrow_oop_base() + r->mapping_offset();
2110 } else {
2111 return heap_region_requested_address();
2112 }
2113 }
2114
2115 // The address where this region can be mapped into the runtime heap without
2116 // patching any of the pointers that are embedded in this region.
2117 address FileMapInfo::heap_region_requested_address() {
2118 assert(UseSharedSpaces, "runtime only");
2119 FileMapRegion* r = region_at(MetaspaceShared::hp);
2120 assert(is_aligned(r->mapping_offset(), sizeof(HeapWord)), "must be");
2121 assert(ArchiveHeapLoader::can_map(), "cannot be used by ArchiveHeapLoader::can_load() mode");
2122 if (UseCompressedOops) {
2123 // We can avoid relocation if each region's offset from the runtime CompressedOops::base()
2124 // is the same as its offset from the CompressedOops::base() during dumptime.
2125 // Note that CompressedOops::base() may be different between dumptime and runtime.
2126 //
2127 // Example:
2128 // Dumptime base = 0x1000 and shift is 0. We have a region at address 0x2000. There's a
2129 // narrowOop P stored in this region that points to an object at address 0x2200.
2130 // P's encoded value is 0x1200.
2131 //
2132 // Runtime base = 0x4000 and shift is also 0. If we map this region at 0x5000, then
2133 // the value P can remain 0x1200. The decoded address = (0x4000 + (0x1200 << 0)) = 0x5200,
2134 // which is the runtime location of the referenced object.
2135 return /*runtime*/ CompressedOops::base() + r->mapping_offset();
2136 } else {
2137 // This was the hard-coded requested base address used at dump time. With uncompressed oops,
2138 // the heap range is assigned by the OS so we will most likely have to relocate anyway, no matter
2139 // what base address was picked at duump time.
2140 return (address)ArchiveHeapWriter::NOCOOPS_REQUESTED_BASE;
2141 }
2142 }
2143
2144 bool FileMapInfo::map_heap_region() {
2145 if (map_heap_region_impl()) {
2146 #ifdef ASSERT
2147 // The "old" regions must be parsable -- we cannot have any unused space
2148 // at the start of the lowest G1 region that contains archived objects.
2149 assert(is_aligned(_mapped_heap_memregion.start(), HeapRegion::GrainBytes), "must be");
2150
2151 // Make sure we map at the very top of the heap - see comments in
2152 // init_heap_region_relocation().
2153 MemRegion heap_range = G1CollectedHeap::heap()->reserved();
2154 assert(heap_range.contains(_mapped_heap_memregion), "must be");
2155
2156 address heap_end = (address)heap_range.end();
2157 address mapped_heap_region_end = (address)_mapped_heap_memregion.end();
2158 assert(heap_end >= mapped_heap_region_end, "must be");
2159 assert(heap_end - mapped_heap_region_end < (intx)(HeapRegion::GrainBytes),
2160 "must be at the top of the heap to avoid fragmentation");
2161 #endif
2162
2163 ArchiveHeapLoader::set_mapped();
2164 return true;
2165 } else {
2166 return false;
2167 }
2168 }
2169
2170 bool FileMapInfo::map_heap_region_impl() {
2171 assert(UseG1GC, "the following code assumes G1");
2172
2173 FileMapRegion* r = region_at(MetaspaceShared::hp);
2174 size_t size = r->used();
2175 if (size == 0) {
2176 return false; // no archived java heap data
2177 }
2178
2179 size_t word_size = size / HeapWordSize;
2180 address requested_start = heap_region_requested_address();
2181
2182 log_info(cds)("Preferred address to map heap data (to avoid relocation) is " INTPTR_FORMAT, p2i(requested_start));
2183
2184 // allocate from java heap
2185 HeapWord* start = G1CollectedHeap::heap()->alloc_archive_region(word_size, (HeapWord*)requested_start);
2186 if (start == nullptr) {
2187 log_info(cds)("UseSharedSpaces: Unable to allocate java heap region for archive heap.");
2188 return false;
2189 }
2190
2191 _mapped_heap_memregion = MemRegion(start, word_size);
2192
2193 // Map the archived heap data. No need to call MemTracker::record_virtual_memory_type()
2194 // for mapped region as it is part of the reserved java heap, which is already recorded.
2195 char* addr = (char*)_mapped_heap_memregion.start();
2196 char* base = map_memory(_fd, _full_path, r->file_offset(),
2197 addr, _mapped_heap_memregion.byte_size(), r->read_only(),
2198 r->allow_exec());
2199 if (base == nullptr || base != addr) {
2200 dealloc_heap_region();
2201 log_info(cds)("UseSharedSpaces: Unable to map at required address in java heap. "
2202 INTPTR_FORMAT ", size = " SIZE_FORMAT " bytes",
2203 p2i(addr), _mapped_heap_memregion.byte_size());
2204 return false;
2205 }
2206
2207 if (VerifySharedSpaces && !r->check_region_crc(base)) {
2208 dealloc_heap_region();
2209 log_info(cds)("UseSharedSpaces: mapped heap region is corrupt");
2210 return false;
2211 }
2212
2213 r->set_mapped_base(base);
2214
2215 // If the requested range is different from the range allocated by GC, then
2216 // the pointers need to be patched.
2217 address mapped_start = (address) _mapped_heap_memregion.start();
2218 ptrdiff_t delta = mapped_start - requested_start;
2219 if (UseCompressedOops &&
2220 (narrow_oop_mode() != CompressedOops::mode() ||
2221 narrow_oop_shift() != CompressedOops::shift())) {
2222 _heap_pointers_need_patching = true;
2223 }
2224 if (delta != 0) {
2225 _heap_pointers_need_patching = true;
2226 }
2227 ArchiveHeapLoader::init_mapped_heap_info(mapped_start, delta, narrow_oop_shift());
2228
2229 if (_heap_pointers_need_patching) {
2230 char* bitmap_base = map_bitmap_region();
2231 if (bitmap_base == nullptr) {
2232 log_info(cds)("CDS heap cannot be used because bitmap region cannot be mapped");
2233 dealloc_heap_region();
2234 unmap_region(MetaspaceShared::hp);
2235 _heap_pointers_need_patching = false;
2236 return false;
2237 }
2238 }
2239 log_info(cds)("Heap data mapped at " INTPTR_FORMAT ", size = " SIZE_FORMAT_W(8) " bytes",
2240 p2i(mapped_start), _mapped_heap_memregion.byte_size());
2241 log_info(cds)("CDS heap data relocation delta = " INTX_FORMAT " bytes", delta);
2242 return true;
2243 }
2244
2245 narrowOop FileMapInfo::encoded_heap_region_dumptime_address() {
2246 assert(UseSharedSpaces, "runtime only");
2247 assert(UseCompressedOops, "sanity");
2248 FileMapRegion* r = region_at(MetaspaceShared::hp);
2249 return CompressedOops::narrow_oop_cast(r->mapping_offset() >> narrow_oop_shift());
2250 }
2251
2252 void FileMapInfo::patch_heap_embedded_pointers() {
2253 if (!ArchiveHeapLoader::is_mapped() || !_heap_pointers_need_patching) {
2254 return;
2255 }
2256
2257 char* bitmap_base = map_bitmap_region();
2258 assert(bitmap_base != nullptr, "must have already been mapped");
2259
2260 FileMapRegion* r = region_at(MetaspaceShared::hp);
2261 ArchiveHeapLoader::patch_embedded_pointers(
2262 this, _mapped_heap_memregion,
2263 (address)(region_at(MetaspaceShared::bm)->mapped_base()) + r->oopmap_offset(),
2264 r->oopmap_size_in_bits());
2265 }
2266
2267 void FileMapInfo::fixup_mapped_heap_region() {
2268 if (ArchiveHeapLoader::is_mapped()) {
2269 assert(!_mapped_heap_memregion.is_empty(), "sanity");
2270
2271 // Populate the archive regions' G1BlockOffsetTableParts. That ensures
2272 // fast G1BlockOffsetTablePart::block_start operations for any given address
2273 // within the archive regions when trying to find start of an object
2274 // (e.g. during card table scanning).
2275 G1CollectedHeap::heap()->populate_archive_regions_bot_part(_mapped_heap_memregion);
2276 }
2277 }
2278
2279 // dealloc the archive regions from java heap
2280 void FileMapInfo::dealloc_heap_region() {
2281 G1CollectedHeap::heap()->dealloc_archive_regions(_mapped_heap_memregion);
2282 }
2283 #endif // INCLUDE_CDS_JAVA_HEAP
2284
2285 void FileMapInfo::unmap_regions(int regions[], int num_regions) {
2286 for (int r = 0; r < num_regions; r++) {
2287 int idx = regions[r];
2288 unmap_region(idx);
2289 }
2290 }
2291
2292 // Unmap a memory region in the address space.
2293
2294 void FileMapInfo::unmap_region(int i) {
2295 FileMapRegion* r = region_at(i);
2296 char* mapped_base = r->mapped_base();
2297 size_t size = r->used_aligned();
2298
2299 if (mapped_base != nullptr) {
2300 if (size > 0 && r->mapped_from_file()) {
2301 log_info(cds)("Unmapping region #%d at base " INTPTR_FORMAT " (%s)", i, p2i(mapped_base),
2302 shared_region_name[i]);
2303 if (!os::unmap_memory(mapped_base, size)) {
2304 fatal("os::unmap_memory failed");
2305 }
2306 }
2307 r->set_mapped_base(nullptr);
2308 }
2309 }
2310
2311 void FileMapInfo::assert_mark(bool check) {
2312 if (!check) {
2313 MetaspaceShared::unrecoverable_loading_error("Mark mismatch while restoring from shared file.");
2314 }
2315 }
2316
2317 FileMapInfo* FileMapInfo::_current_info = nullptr;
2318 FileMapInfo* FileMapInfo::_dynamic_archive_info = nullptr;
2319 bool FileMapInfo::_heap_pointers_need_patching = false;
2320 SharedPathTable FileMapInfo::_shared_path_table;
2321 bool FileMapInfo::_validating_shared_path_table = false;
2322 bool FileMapInfo::_memory_mapping_failed = false;
2323 GrowableArray<const char*>* FileMapInfo::_non_existent_class_paths = nullptr;
2324
2325 // Open the shared archive file, read and validate the header
2326 // information (version, boot classpath, etc.). If initialization
2327 // fails, shared spaces are disabled and the file is closed.
2328 //
2329 // Validation of the archive is done in two steps:
2330 //
2331 // [1] validate_header() - done here.
2332 // [2] validate_shared_path_table - this is done later, because the table is in the RW
2333 // region of the archive, which is not mapped yet.
2334 bool FileMapInfo::initialize() {
2335 assert(UseSharedSpaces, "UseSharedSpaces expected.");
2336 assert(Arguments::has_jimage(), "The shared archive file cannot be used with an exploded module build.");
2337
2338 if (JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()) {
2339 // CDS assumes that no classes resolved in vmClasses::resolve_all()
2340 // are replaced at runtime by JVMTI ClassFileLoadHook. All of those classes are resolved
2341 // during the JVMTI "early" stage, so we can still use CDS if
2342 // JvmtiExport::has_early_class_hook_env() is false.
2343 log_info(cds)("CDS is disabled because early JVMTI ClassFileLoadHook is in use.");
2344 return false;
2345 }
2346
2347 if (!open_for_read() || !init_from_file(_fd) || !validate_header()) {
2348 if (_is_static) {
2349 log_info(cds)("Initialize static archive failed.");
2350 return false;
2351 } else {
2352 log_info(cds)("Initialize dynamic archive failed.");
2353 if (AutoCreateSharedArchive) {
2354 CDSConfig::enable_dumping_dynamic_archive();
2355 ArchiveClassesAtExit = CDSConfig::dynamic_archive_path();
2356 }
2357 return false;
2358 }
2359 }
2360
2361 return true;
2362 }
2363
2364 // The 2 core spaces are RW->RO
2365 FileMapRegion* FileMapInfo::first_core_region() const {
2366 return region_at(MetaspaceShared::rw);
2367 }
2368
2369 FileMapRegion* FileMapInfo::last_core_region() const {
2370 return region_at(MetaspaceShared::ro);
2371 }
2372
2373 void FileMapInfo::print(outputStream* st) const {
2374 header()->print(st);
2375 if (!is_static()) {
2376 dynamic_header()->print(st);
2377 }
2378 }
2379
2380 void FileMapHeader::set_as_offset(char* p, size_t *offset) {
2381 *offset = ArchiveBuilder::current()->any_to_offset((address)p);
2382 }
2383
2384 int FileMapHeader::compute_crc() {
2385 char* start = (char*)this;
2386 // start computing from the field after _header_size to end of base archive name.
2387 char* buf = (char*)&(_generic_header._header_size) + sizeof(_generic_header._header_size);
2388 size_t sz = header_size() - (buf - start);
2389 int crc = ClassLoader::crc32(0, buf, (jint)sz);
2390 return crc;
2391 }
2392
2393 // This function should only be called during run time with UseSharedSpaces enabled.
2394 bool FileMapHeader::validate() {
2395 if (_obj_alignment != ObjectAlignmentInBytes) {
2396 log_info(cds)("The shared archive file's ObjectAlignmentInBytes of %d"
2397 " does not equal the current ObjectAlignmentInBytes of %d.",
2398 _obj_alignment, ObjectAlignmentInBytes);
2399 return false;
2400 }
2401 if (_compact_strings != CompactStrings) {
2402 log_info(cds)("The shared archive file's CompactStrings setting (%s)"
2403 " does not equal the current CompactStrings setting (%s).",
2404 _compact_strings ? "enabled" : "disabled",
2405 CompactStrings ? "enabled" : "disabled");
2406 return false;
2407 }
2408
2409 // This must be done after header validation because it might change the
2410 // header data
2411 const char* prop = Arguments::get_property("java.system.class.loader");
2412 if (prop != nullptr) {
2413 log_warning(cds)("Archived non-system classes are disabled because the "
2414 "java.system.class.loader property is specified (value = \"%s\"). "
2415 "To use archived non-system classes, this property must not be set", prop);
2416 _has_platform_or_app_classes = false;
2417 }
2418
2419
2420 if (!_verify_local && BytecodeVerificationLocal) {
2421 // we cannot load boot classes, so there's no point of using the CDS archive
2422 log_info(cds)("The shared archive file's BytecodeVerificationLocal setting (%s)"
2423 " does not equal the current BytecodeVerificationLocal setting (%s).",
2424 _verify_local ? "enabled" : "disabled",
2425 BytecodeVerificationLocal ? "enabled" : "disabled");
2426 return false;
2427 }
2428
2429 // For backwards compatibility, we don't check the BytecodeVerificationRemote setting
2430 // if the archive only contains system classes.
2431 if (_has_platform_or_app_classes
2432 && !_verify_remote // we didn't verify the archived platform/app classes
2433 && BytecodeVerificationRemote) { // but we want to verify all loaded platform/app classes
2434 log_info(cds)("The shared archive file was created with less restrictive "
2435 "verification setting than the current setting.");
2436 // Pretend that we didn't have any archived platform/app classes, so they won't be loaded
2437 // by SystemDictionaryShared.
2438 _has_platform_or_app_classes = false;
2439 }
2440
2441 // Java agents are allowed during run time. Therefore, the following condition is not
2442 // checked: (!_allow_archiving_with_java_agent && AllowArchivingWithJavaAgent)
2443 // Note: _allow_archiving_with_java_agent is set in the shared archive during dump time
2444 // while AllowArchivingWithJavaAgent is set during the current run.
2445 if (_allow_archiving_with_java_agent && !AllowArchivingWithJavaAgent) {
2446 log_warning(cds)("The setting of the AllowArchivingWithJavaAgent is different "
2447 "from the setting in the shared archive.");
2448 return false;
2449 }
2450
2451 if (_allow_archiving_with_java_agent) {
2452 log_warning(cds)("This archive was created with AllowArchivingWithJavaAgent. It should be used "
2453 "for testing purposes only and should not be used in a production environment");
2454 }
2455
2456 log_info(cds)("Archive was created with UseCompressedOops = %d, UseCompressedClassPointers = %d",
2457 compressed_oops(), compressed_class_pointers());
2458 if (compressed_oops() != UseCompressedOops || compressed_class_pointers() != UseCompressedClassPointers) {
2459 log_info(cds)("Unable to use shared archive.\nThe saved state of UseCompressedOops and UseCompressedClassPointers is "
2460 "different from runtime, CDS will be disabled.");
2461 return false;
2462 }
2463
2464 if (is_static()) {
2465 const char* err = nullptr;
2466 if (CDSConfig::is_valhalla_preview()) {
2467 if (!_has_valhalla_patched_classes) {
2468 err = "not created";
2469 }
2470 } else {
2471 if (_has_valhalla_patched_classes) {
2472 err = "created";
2473 }
2474 }
2475 if (err != nullptr) {
2476 log_warning(cds)("This archive was %s with --enable-preview -XX:+EnableValhalla. It is "
2477 "incompatible with the current JVM setting", err);
2478 return false;
2479 }
2480 }
2481
2482 if (!_use_optimized_module_handling) {
2483 MetaspaceShared::disable_optimized_module_handling();
2484 log_info(cds)("optimized module handling: disabled because archive was created without optimized module handling");
2485 }
2486
2487 if (is_static() && !_has_full_module_graph) {
2488 // Only the static archive can contain the full module graph.
2489 CDSConfig::disable_loading_full_module_graph("archive was created without full module graph");
2490 }
2491
2492 return true;
2493 }
2494
2495 bool FileMapInfo::validate_header() {
2496 if (!header()->validate()) {
2497 return false;
2498 }
2499 if (_is_static) {
2500 return true;
2501 } else {
2502 return DynamicArchive::validate(this);
2503 }
2504 }
2505
2506 #if INCLUDE_JVMTI
2507 ClassPathEntry** FileMapInfo::_classpath_entries_for_jvmti = nullptr;
2508
2509 ClassPathEntry* FileMapInfo::get_classpath_entry_for_jvmti(int i, TRAPS) {
2510 if (i == 0) {
2511 // index 0 corresponds to the ClassPathImageEntry which is a globally shared object
2512 // and should never be deleted.
2513 return ClassLoader::get_jrt_entry();
2514 }
2515 ClassPathEntry* ent = _classpath_entries_for_jvmti[i];
2516 if (ent == nullptr) {
2517 SharedClassPathEntry* scpe = shared_path(i);
2518 assert(scpe->is_jar(), "must be"); // other types of scpe will not produce archived classes
2519
2520 const char* path = scpe->name();
2521 struct stat st;
2522 if (os::stat(path, &st) != 0) {
2523 char *msg = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, strlen(path) + 128);
2524 jio_snprintf(msg, strlen(path) + 127, "error in finding JAR file %s", path);
2525 THROW_MSG_(vmSymbols::java_io_IOException(), msg, nullptr);
2526 } else {
2527 ent = ClassLoader::create_class_path_entry(THREAD, path, &st, false, false);
2528 if (ent == nullptr) {
2529 char *msg = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, strlen(path) + 128);
2530 jio_snprintf(msg, strlen(path) + 127, "error in opening JAR file %s", path);
2531 THROW_MSG_(vmSymbols::java_io_IOException(), msg, nullptr);
2532 }
2533 }
2534
2535 MutexLocker mu(THREAD, CDSClassFileStream_lock);
2536 if (_classpath_entries_for_jvmti[i] == nullptr) {
2537 _classpath_entries_for_jvmti[i] = ent;
2538 } else {
2539 // Another thread has beat me to creating this entry
2540 delete ent;
2541 ent = _classpath_entries_for_jvmti[i];
2542 }
2543 }
2544
2545 return ent;
2546 }
2547
2548 ClassFileStream* FileMapInfo::open_stream_for_jvmti(InstanceKlass* ik, Handle class_loader, TRAPS) {
2549 int path_index = ik->shared_classpath_index();
2550 assert(path_index >= 0, "should be called for shared built-in classes only");
2551 assert(path_index < (int)get_number_of_shared_paths(), "sanity");
2552
2553 ClassPathEntry* cpe = get_classpath_entry_for_jvmti(path_index, CHECK_NULL);
2554 assert(cpe != nullptr, "must be");
2555
2556 Symbol* name = ik->name();
2557 const char* const class_name = name->as_C_string();
2558 const char* const file_name = ClassLoader::file_name_for_class_name(class_name,
2559 name->utf8_length());
2560 ClassLoaderData* loader_data = ClassLoaderData::class_loader_data(class_loader());
2561 ClassFileStream* cfs = cpe->open_stream_for_loader(THREAD, file_name, loader_data);
2562 assert(cfs != nullptr, "must be able to read the classfile data of shared classes for built-in loaders.");
2563 log_debug(cds, jvmti)("classfile data for %s [%d: %s] = %d bytes", class_name, path_index,
2564 cfs->source(), cfs->length());
2565 return cfs;
2566 }
2567
2568 #endif