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