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