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