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