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