1 /*
2 * Copyright (c) 2003, 2025, 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 "cds/aotClassLocation.hpp"
26 #include "cds/aotLogging.hpp"
27 #include "cds/archiveBuilder.hpp"
28 #include "cds/archiveHeapLoader.inline.hpp"
29 #include "cds/archiveHeapWriter.hpp"
30 #include "cds/archiveUtils.inline.hpp"
31 #include "cds/cds_globals.hpp"
32 #include "cds/cdsConfig.hpp"
33 #include "cds/dynamicArchive.hpp"
34 #include "cds/filemap.hpp"
35 #include "cds/heapShared.hpp"
36 #include "cds/metaspaceShared.hpp"
37 #include "classfile/altHashing.hpp"
38 #include "classfile/classFileStream.hpp"
39 #include "classfile/classLoader.hpp"
40 #include "classfile/classLoader.inline.hpp"
41 #include "classfile/classLoaderData.inline.hpp"
42 #include "classfile/symbolTable.hpp"
43 #include "classfile/systemDictionaryShared.hpp"
44 #include "classfile/vmClasses.hpp"
45 #include "classfile/vmSymbols.hpp"
46 #include "compiler/compilerDefinitions.inline.hpp"
47 #include "jvm.h"
48 #include "logging/log.hpp"
49 #include "logging/logMessage.hpp"
50 #include "logging/logStream.hpp"
51 #include "memory/iterator.inline.hpp"
52 #include "memory/metadataFactory.hpp"
53 #include "memory/metaspaceClosure.hpp"
54 #include "memory/oopFactory.hpp"
55 #include "memory/universe.hpp"
56 #include "nmt/memTracker.hpp"
57 #include "oops/access.hpp"
58 #include "oops/compressedKlass.hpp"
59 #include "oops/compressedOops.hpp"
60 #include "oops/compressedOops.inline.hpp"
61 #include "oops/objArrayOop.hpp"
62 #include "oops/oop.inline.hpp"
63 #include "oops/trainingData.hpp"
64 #include "oops/typeArrayKlass.hpp"
65 #include "prims/jvmtiExport.hpp"
66 #include "runtime/arguments.hpp"
67 #include "runtime/globals_extension.hpp"
68 #include "runtime/java.hpp"
69 #include "runtime/javaCalls.hpp"
70 #include "runtime/mutexLocker.hpp"
71 #include "runtime/os.hpp"
72 #include "runtime/vm_version.hpp"
73 #include "utilities/align.hpp"
74 #include "utilities/bitMap.inline.hpp"
75 #include "utilities/classpathStream.hpp"
76 #include "utilities/defaultStream.hpp"
77 #include "utilities/ostream.hpp"
78 #if INCLUDE_G1GC
79 #include "gc/g1/g1CollectedHeap.hpp"
80 #include "gc/g1/g1HeapRegion.hpp"
81 #endif
82
83 #include <errno.h>
84 #include <sys/stat.h>
85
86 #ifndef O_BINARY // if defined (Win32) use binary files.
87 #define O_BINARY 0 // otherwise do nothing.
88 #endif
89
90 inline void CDSMustMatchFlags::do_print(outputStream* st, bool v) {
91 st->print("%s", v ? "true" : "false");
92 }
93
94 inline void CDSMustMatchFlags::do_print(outputStream* st, intx v) {
95 st->print("%zd", v);
96 }
97
98 inline void CDSMustMatchFlags::do_print(outputStream* st, uintx v) {
99 st->print("%zu", v);
100 }
101
102 inline void CDSMustMatchFlags::do_print(outputStream* st, double v) {
103 st->print("%f", v);
104 }
105
106 void CDSMustMatchFlags::init() {
107 assert(CDSConfig::is_dumping_archive(), "sanity");
108 _max_name_width = 0;
109
110 #define INIT_CDS_MUST_MATCH_FLAG(n) \
111 _v_##n = n; \
112 _max_name_width = MAX2(_max_name_width,strlen(#n));
113 CDS_MUST_MATCH_FLAGS_DO(INIT_CDS_MUST_MATCH_FLAG);
114 #undef INIT_CDS_MUST_MATCH_FLAG
115 }
116
117 bool CDSMustMatchFlags::runtime_check() const {
118 #define CHECK_CDS_MUST_MATCH_FLAG(n) \
119 if (_v_##n != n) { \
120 ResourceMark rm; \
121 stringStream ss; \
122 ss.print("VM option %s is different between dumptime (", #n); \
123 do_print(&ss, _v_ ## n); \
124 ss.print(") and runtime ("); \
125 do_print(&ss, n); \
126 ss.print(")"); \
127 log_info(cds)("%s", ss.as_string()); \
128 return false; \
129 }
130 CDS_MUST_MATCH_FLAGS_DO(CHECK_CDS_MUST_MATCH_FLAG);
131 #undef CHECK_CDS_MUST_MATCH_FLAG
132
133 return true;
134 }
135
136 void CDSMustMatchFlags::print_info() const {
137 LogTarget(Info, cds) lt;
138 if (lt.is_enabled()) {
139 LogStream ls(lt);
140 ls.print_cr("Recorded VM flags during dumptime:");
141 print(&ls);
142 }
143 }
144
145 void CDSMustMatchFlags::print(outputStream* st) const {
146 #define PRINT_CDS_MUST_MATCH_FLAG(n) \
147 st->print("- %-s ", #n); \
148 st->sp(int(_max_name_width - strlen(#n))); \
149 do_print(st, _v_##n); \
150 st->cr();
151 CDS_MUST_MATCH_FLAGS_DO(PRINT_CDS_MUST_MATCH_FLAG);
152 #undef PRINT_CDS_MUST_MATCH_FLAG
153 }
154
155 // Fill in the fileMapInfo structure with data about this VM instance.
156
157 // This method copies the vm version info into header_version. If the version is too
158 // long then a truncated version, which has a hash code appended to it, is copied.
159 //
160 // Using a template enables this method to verify that header_version is an array of
161 // length JVM_IDENT_MAX. This ensures that the code that writes to the CDS file and
162 // the code that reads the CDS file will both use the same size buffer. Hence, will
163 // use identical truncation. This is necessary for matching of truncated versions.
164 template <int N> static void get_header_version(char (&header_version) [N]) {
165 assert(N == JVM_IDENT_MAX, "Bad header_version size");
166
167 const char *vm_version = VM_Version::internal_vm_info_string();
168 const int version_len = (int)strlen(vm_version);
169
170 memset(header_version, 0, JVM_IDENT_MAX);
171
172 if (version_len < (JVM_IDENT_MAX-1)) {
173 strcpy(header_version, vm_version);
174
175 } else {
176 // Get the hash value. Use a static seed because the hash needs to return the same
177 // value over multiple jvm invocations.
178 uint32_t hash = AltHashing::halfsiphash_32(8191, (const uint8_t*)vm_version, version_len);
179
180 // Truncate the ident, saving room for the 8 hex character hash value.
181 strncpy(header_version, vm_version, JVM_IDENT_MAX-9);
182
183 // Append the hash code as eight hex digits.
184 os::snprintf_checked(&header_version[JVM_IDENT_MAX-9], 9, "%08x", hash);
185 header_version[JVM_IDENT_MAX-1] = 0; // Null terminate.
186 }
187
188 assert(header_version[JVM_IDENT_MAX-1] == 0, "must be");
189 }
190
191 FileMapInfo::FileMapInfo(const char* full_path, bool is_static) :
192 _is_static(is_static), _file_open(false), _is_mapped(false), _fd(-1), _file_offset(0),
193 _full_path(full_path), _base_archive_name(nullptr), _header(nullptr) {
194 if (_is_static) {
195 assert(_current_info == nullptr, "must be singleton"); // not thread safe
196 _current_info = this;
197 } else {
198 assert(_dynamic_archive_info == nullptr, "must be singleton"); // not thread safe
199 _dynamic_archive_info = this;
200 }
201 }
202
203 FileMapInfo::~FileMapInfo() {
204 if (_is_static) {
205 assert(_current_info == this, "must be singleton"); // not thread safe
206 _current_info = nullptr;
207 } else {
208 assert(_dynamic_archive_info == this, "must be singleton"); // not thread safe
209 _dynamic_archive_info = nullptr;
210 }
211
212 if (_header != nullptr) {
213 os::free(_header);
214 }
215
216 if (_file_open) {
217 ::close(_fd);
218 }
219 }
220
221 void FileMapInfo::free_current_info() {
222 assert(CDSConfig::is_dumping_final_static_archive(), "only supported in this mode");
223 assert(_current_info != nullptr, "sanity");
224 delete _current_info;
225 assert(_current_info == nullptr, "sanity"); // Side effect expected from the above "delete" operator.
226 }
227
228 void FileMapInfo::populate_header(size_t core_region_alignment) {
229 assert(_header == nullptr, "Sanity check");
230 size_t c_header_size;
231 size_t header_size;
232 size_t base_archive_name_size = 0;
233 size_t base_archive_name_offset = 0;
234 if (is_static()) {
235 c_header_size = sizeof(FileMapHeader);
236 header_size = c_header_size;
237 } else {
238 // dynamic header including base archive name for non-default base archive
239 c_header_size = sizeof(DynamicArchiveHeader);
240 header_size = c_header_size;
241
242 const char* default_base_archive_name = CDSConfig::default_archive_path();
243 const char* current_base_archive_name = CDSConfig::input_static_archive_path();
244 if (!os::same_files(current_base_archive_name, default_base_archive_name)) {
245 base_archive_name_size = strlen(current_base_archive_name) + 1;
246 header_size += base_archive_name_size;
247 base_archive_name_offset = c_header_size;
248 }
249 }
250 _header = (FileMapHeader*)os::malloc(header_size, mtInternal);
251 memset((void*)_header, 0, header_size);
252 _header->populate(this,
253 core_region_alignment,
254 header_size,
255 base_archive_name_size,
256 base_archive_name_offset);
257 }
258
259 void FileMapHeader::populate(FileMapInfo *info, size_t core_region_alignment,
260 size_t header_size, size_t base_archive_name_size,
261 size_t base_archive_name_offset) {
262 // 1. We require _generic_header._magic to be at the beginning of the file
263 // 2. FileMapHeader also assumes that _generic_header is at the beginning of the file
264 assert(offset_of(FileMapHeader, _generic_header) == 0, "must be");
265 set_header_size((unsigned int)header_size);
266 set_base_archive_name_offset((unsigned int)base_archive_name_offset);
267 set_base_archive_name_size((unsigned int)base_archive_name_size);
268 if (CDSConfig::is_dumping_dynamic_archive()) {
269 set_magic(CDS_DYNAMIC_ARCHIVE_MAGIC);
270 } else if (CDSConfig::is_dumping_preimage_static_archive()) {
271 set_magic(CDS_PREIMAGE_ARCHIVE_MAGIC);
272 } else {
273 set_magic(CDS_ARCHIVE_MAGIC);
274 }
275 set_version(CURRENT_CDS_ARCHIVE_VERSION);
276
277 if (!info->is_static() && base_archive_name_size != 0) {
278 // copy base archive name
279 copy_base_archive_name(CDSConfig::input_static_archive_path());
280 }
281 _core_region_alignment = core_region_alignment;
282 _obj_alignment = ObjectAlignmentInBytes;
283 _compact_strings = CompactStrings;
284 _compact_headers = UseCompactObjectHeaders;
285 if (CDSConfig::is_dumping_heap()) {
286 _narrow_oop_mode = CompressedOops::mode();
287 _narrow_oop_base = CompressedOops::base();
288 _narrow_oop_shift = CompressedOops::shift();
289 }
290 _compressed_oops = UseCompressedOops;
291 _compressed_class_ptrs = UseCompressedClassPointers;
292 if (UseCompressedClassPointers) {
293 #ifdef _LP64
294 _narrow_klass_pointer_bits = CompressedKlassPointers::narrow_klass_pointer_bits();
295 _narrow_klass_shift = ArchiveBuilder::precomputed_narrow_klass_shift();
296 #endif
297 } else {
298 _narrow_klass_pointer_bits = _narrow_klass_shift = -1;
299 }
300 // Which JIT compier is used
301 _compiler_type = (u1)CompilerConfig::compiler_type();
302 _type_profile_level = TypeProfileLevel;
303 _type_profile_args_limit = TypeProfileArgsLimit;
304 _type_profile_parms_limit = TypeProfileParmsLimit;
305 _type_profile_width = TypeProfileWidth;
306 _bci_profile_width = BciProfileWidth;
307 _profile_traps = ProfileTraps;
308 _type_profile_casts = TypeProfileCasts;
309 _spec_trap_limit_extra_entries = SpecTrapLimitExtraEntries;
310 _max_heap_size = MaxHeapSize;
311 _use_optimized_module_handling = CDSConfig::is_using_optimized_module_handling();
312 _has_aot_linked_classes = CDSConfig::is_dumping_aot_linked_classes();
313 _has_full_module_graph = CDSConfig::is_dumping_full_module_graph();
314 _has_valhalla_patched_classes = CDSConfig::is_valhalla_preview();
315
316 // The following fields are for sanity checks for whether this archive
317 // will function correctly with this JVM and the bootclasspath it's
318 // invoked with.
319
320 // JVM version string ... changes on each build.
321 get_header_version(_jvm_ident);
322
323 _verify_local = BytecodeVerificationLocal;
324 _verify_remote = BytecodeVerificationRemote;
325 _has_platform_or_app_classes = AOTClassLocationConfig::dumptime()->has_platform_or_app_classes();
326 _requested_base_address = (char*)SharedBaseAddress;
327 _mapped_base_address = (char*)SharedBaseAddress;
328 _allow_archiving_with_java_agent = AllowArchivingWithJavaAgent;
329 _must_match.init();
330 }
331
332 void FileMapHeader::copy_base_archive_name(const char* archive) {
333 assert(base_archive_name_size() != 0, "_base_archive_name_size not set");
334 assert(base_archive_name_offset() != 0, "_base_archive_name_offset not set");
335 assert(header_size() > sizeof(*this), "_base_archive_name_size not included in header size?");
336 memcpy((char*)this + base_archive_name_offset(), archive, base_archive_name_size());
337 }
338
339 void FileMapHeader::print(outputStream* st) {
340 ResourceMark rm;
341
342 st->print_cr("- magic: 0x%08x", magic());
343 st->print_cr("- crc: 0x%08x", crc());
344 st->print_cr("- version: 0x%x", version());
345 st->print_cr("- header_size: " UINT32_FORMAT, header_size());
346 st->print_cr("- base_archive_name_offset: " UINT32_FORMAT, base_archive_name_offset());
347 st->print_cr("- base_archive_name_size: " UINT32_FORMAT, base_archive_name_size());
348
349 for (int i = 0; i < NUM_CDS_REGIONS; i++) {
350 FileMapRegion* r = region_at(i);
351 r->print(st, i);
352 }
353 st->print_cr("============ end regions ======== ");
354
355 st->print_cr("- core_region_alignment: %zu", _core_region_alignment);
356 st->print_cr("- obj_alignment: %d", _obj_alignment);
357 st->print_cr("- narrow_oop_base: " INTPTR_FORMAT, p2i(_narrow_oop_base));
358 st->print_cr("- narrow_oop_shift %d", _narrow_oop_shift);
359 st->print_cr("- compact_strings: %d", _compact_strings);
360 st->print_cr("- compact_headers: %d", _compact_headers);
361 st->print_cr("- max_heap_size: %zu", _max_heap_size);
362 st->print_cr("- narrow_oop_mode: %d", _narrow_oop_mode);
363 st->print_cr("- compressed_oops: %d", _compressed_oops);
364 st->print_cr("- compressed_class_ptrs: %d", _compressed_class_ptrs);
365 st->print_cr("- narrow_klass_pointer_bits: %d", _narrow_klass_pointer_bits);
366 st->print_cr("- narrow_klass_shift: %d", _narrow_klass_shift);
367 st->print_cr("- cloned_vtables_offset: 0x%zx", _cloned_vtables_offset);
368 st->print_cr("- early_serialized_data_offset: 0x%zx", _early_serialized_data_offset);
369 st->print_cr("- serialized_data_offset: 0x%zx", _serialized_data_offset);
370 st->print_cr("- jvm_ident: %s", _jvm_ident);
371 st->print_cr("- class_location_config_offset: 0x%zx", _class_location_config_offset);
372 st->print_cr("- verify_local: %d", _verify_local);
373 st->print_cr("- verify_remote: %d", _verify_remote);
374 st->print_cr("- has_platform_or_app_classes: %d", _has_platform_or_app_classes);
375 st->print_cr("- requested_base_address: " INTPTR_FORMAT, p2i(_requested_base_address));
376 st->print_cr("- mapped_base_address: " INTPTR_FORMAT, p2i(_mapped_base_address));
377 st->print_cr("- heap_root_segments.roots_count: %d" , _heap_root_segments.roots_count());
378 st->print_cr("- heap_root_segments.base_offset: 0x%zx", _heap_root_segments.base_offset());
379 st->print_cr("- heap_root_segments.count: %zu", _heap_root_segments.count());
380 st->print_cr("- heap_root_segments.max_size_elems: %d", _heap_root_segments.max_size_in_elems());
381 st->print_cr("- heap_root_segments.max_size_bytes: %d", _heap_root_segments.max_size_in_bytes());
382 st->print_cr("- _heap_oopmap_start_pos: %zu", _heap_oopmap_start_pos);
383 st->print_cr("- _heap_ptrmap_start_pos: %zu", _heap_ptrmap_start_pos);
384 st->print_cr("- _rw_ptrmap_start_pos: %zu", _rw_ptrmap_start_pos);
385 st->print_cr("- _ro_ptrmap_start_pos: %zu", _ro_ptrmap_start_pos);
386 st->print_cr("- allow_archiving_with_java_agent:%d", _allow_archiving_with_java_agent);
387 st->print_cr("- use_optimized_module_handling: %d", _use_optimized_module_handling);
388 st->print_cr("- has_full_module_graph %d", _has_full_module_graph);
389 st->print_cr("- has_valhalla_patched_classes %d", _has_valhalla_patched_classes);
390 _must_match.print(st);
391 st->print_cr("- has_aot_linked_classes %d", _has_aot_linked_classes);
392 }
393
394 bool FileMapInfo::validate_class_location() {
395 assert(CDSConfig::is_using_archive(), "runtime only");
396
397 AOTClassLocationConfig* config = header()->class_location_config();
398 bool has_extra_module_paths = false;
399 if (!config->validate(full_path(), header()->has_aot_linked_classes(), &has_extra_module_paths)) {
400 if (PrintSharedArchiveAndExit) {
401 MetaspaceShared::set_archive_loading_failed();
402 return true;
403 } else {
404 return false;
405 }
406 }
407
408 if (header()->has_full_module_graph() && has_extra_module_paths) {
409 CDSConfig::stop_using_optimized_module_handling();
410 MetaspaceShared::report_loading_error("optimized module handling: disabled because extra module path(s) are specified");
411 }
412
413 if (CDSConfig::is_dumping_dynamic_archive()) {
414 // Only support dynamic dumping with the usage of the default CDS archive
415 // or a simple base archive.
416 // If the base layer archive contains additional path component besides
417 // the runtime image and the -cp, dynamic dumping is disabled.
418 if (config->num_boot_classpaths() > 0) {
419 CDSConfig::disable_dumping_dynamic_archive();
420 aot_log_warning(aot)(
421 "Dynamic archiving is disabled because base layer archive has appended boot classpath");
422 }
423 if (config->num_module_paths() > 0) {
424 if (has_extra_module_paths) {
425 CDSConfig::disable_dumping_dynamic_archive();
426 aot_log_warning(aot)(
427 "Dynamic archiving is disabled because base layer archive has a different module path");
428 }
429 }
430 }
431
432 #if INCLUDE_JVMTI
433 if (_classpath_entries_for_jvmti != nullptr) {
434 os::free(_classpath_entries_for_jvmti);
435 }
436 size_t sz = sizeof(ClassPathEntry*) * AOTClassLocationConfig::runtime()->length();
437 _classpath_entries_for_jvmti = (ClassPathEntry**)os::malloc(sz, mtClass);
438 memset((void*)_classpath_entries_for_jvmti, 0, sz);
439 #endif
440
441 return true;
442 }
443
444 // A utility class for reading/validating the GenericCDSFileMapHeader portion of
445 // a CDS archive's header. The file header of all CDS archives with versions from
446 // CDS_GENERIC_HEADER_SUPPORTED_MIN_VERSION (12) are guaranteed to always start
447 // with GenericCDSFileMapHeader. This makes it possible to read important information
448 // from a CDS archive created by a different version of HotSpot, so that we can
449 // automatically regenerate the archive as necessary (JDK-8261455).
450 class FileHeaderHelper {
451 int _fd;
452 bool _is_valid;
453 bool _is_static;
454 GenericCDSFileMapHeader* _header;
455 const char* _archive_name;
456 const char* _base_archive_name;
457
458 public:
459 FileHeaderHelper(const char* archive_name, bool is_static) {
460 _fd = -1;
461 _is_valid = false;
462 _header = nullptr;
463 _base_archive_name = nullptr;
464 _archive_name = archive_name;
465 _is_static = is_static;
466 }
467
468 ~FileHeaderHelper() {
469 if (_header != nullptr) {
470 FREE_C_HEAP_ARRAY(char, _header);
471 }
472 if (_fd != -1) {
473 ::close(_fd);
474 }
475 }
476
477 bool initialize() {
478 assert(_archive_name != nullptr, "Archive name is null");
479 _fd = os::open(_archive_name, O_RDONLY | O_BINARY, 0);
480 if (_fd < 0) {
481 MetaspaceShared::report_loading_error("Specified %s not found (%s)", CDSConfig::type_of_archive_being_loaded(), _archive_name);
482 return false;
483 }
484 return initialize(_fd);
485 }
486
487 // for an already opened file, do not set _fd
488 bool initialize(int fd) {
489 assert(_archive_name != nullptr, "Archive name is null");
490 assert(fd != -1, "Archive must be opened already");
491 // First read the generic header so we know the exact size of the actual header.
492 const char* file_type = CDSConfig::type_of_archive_being_loaded();
493 GenericCDSFileMapHeader gen_header;
494 size_t size = sizeof(GenericCDSFileMapHeader);
495 os::lseek(fd, 0, SEEK_SET);
496 size_t n = ::read(fd, (void*)&gen_header, (unsigned int)size);
497 if (n != size) {
498 aot_log_warning(aot)("Unable to read generic CDS file map header from %s", file_type);
499 return false;
500 }
501
502 if (gen_header._magic != CDS_ARCHIVE_MAGIC &&
503 gen_header._magic != CDS_DYNAMIC_ARCHIVE_MAGIC &&
504 gen_header._magic != CDS_PREIMAGE_ARCHIVE_MAGIC) {
505 aot_log_warning(aot)("The %s has a bad magic number: %#x", file_type, gen_header._magic);
506 return false;
507 }
508
509 if (gen_header._version < CDS_GENERIC_HEADER_SUPPORTED_MIN_VERSION) {
510 aot_log_warning(aot)("Cannot handle %s version 0x%x. Must be at least 0x%x.",
511 file_type, gen_header._version, CDS_GENERIC_HEADER_SUPPORTED_MIN_VERSION);
512 return false;
513 }
514
515 if (gen_header._version != CURRENT_CDS_ARCHIVE_VERSION) {
516 aot_log_warning(aot)("The %s version 0x%x does not match the required version 0x%x.",
517 file_type, gen_header._version, CURRENT_CDS_ARCHIVE_VERSION);
518 }
519
520 size_t filelen = os::lseek(fd, 0, SEEK_END);
521 if (gen_header._header_size >= filelen) {
522 aot_log_warning(aot)("Archive file header larger than archive file");
523 return false;
524 }
525
526 // Read the actual header and perform more checks
527 size = gen_header._header_size;
528 _header = (GenericCDSFileMapHeader*)NEW_C_HEAP_ARRAY(char, size, mtInternal);
529 os::lseek(fd, 0, SEEK_SET);
530 n = ::read(fd, (void*)_header, (unsigned int)size);
531 if (n != size) {
532 aot_log_warning(aot)("Unable to read file map header from %s", file_type);
533 return false;
534 }
535
536 if (!check_header_crc()) {
537 return false;
538 }
539
540 if (!check_and_init_base_archive_name()) {
541 return false;
542 }
543
544 // All fields in the GenericCDSFileMapHeader has been validated.
545 _is_valid = true;
546 return true;
547 }
548
549 GenericCDSFileMapHeader* get_generic_file_header() {
550 assert(_header != nullptr && _is_valid, "must be a valid archive file");
551 return _header;
552 }
553
554 const char* base_archive_name() {
555 assert(_header != nullptr && _is_valid, "must be a valid archive file");
556 return _base_archive_name;
557 }
558
559 bool is_static_archive() const {
560 return _header->_magic == CDS_ARCHIVE_MAGIC;
561 }
562
563 bool is_dynamic_archive() const {
564 return _header->_magic == CDS_DYNAMIC_ARCHIVE_MAGIC;
565 }
566
567 bool is_preimage_static_archive() const {
568 return _header->_magic == CDS_PREIMAGE_ARCHIVE_MAGIC;
569 }
570
571 private:
572 bool check_header_crc() const {
573 if (VerifySharedSpaces) {
574 FileMapHeader* header = (FileMapHeader*)_header;
575 int actual_crc = header->compute_crc();
576 if (actual_crc != header->crc()) {
577 aot_log_info(aot)("_crc expected: %d", header->crc());
578 aot_log_info(aot)(" actual: %d", actual_crc);
579 aot_log_warning(aot)("Header checksum verification failed.");
580 return false;
581 }
582 }
583 return true;
584 }
585
586 bool check_and_init_base_archive_name() {
587 unsigned int name_offset = _header->_base_archive_name_offset;
588 unsigned int name_size = _header->_base_archive_name_size;
589 unsigned int header_size = _header->_header_size;
590
591 if (name_offset + name_size < name_offset) {
592 aot_log_warning(aot)("base_archive_name offset/size overflow: " UINT32_FORMAT "/" UINT32_FORMAT,
593 name_offset, name_size);
594 return false;
595 }
596
597 if (is_static_archive() || is_preimage_static_archive()) {
598 if (name_offset != 0) {
599 aot_log_warning(aot)("static shared archive must have zero _base_archive_name_offset");
600 return false;
601 }
602 if (name_size != 0) {
603 aot_log_warning(aot)("static shared archive must have zero _base_archive_name_size");
604 return false;
605 }
606 } else {
607 assert(is_dynamic_archive(), "must be");
608 if ((name_size == 0 && name_offset != 0) ||
609 (name_size != 0 && name_offset == 0)) {
610 // If either is zero, both must be zero. This indicates that we are using the default base archive.
611 aot_log_warning(aot)("Invalid base_archive_name offset/size: " UINT32_FORMAT "/" UINT32_FORMAT,
612 name_offset, name_size);
613 return false;
614 }
615 if (name_size > 0) {
616 if (name_offset + name_size > header_size) {
617 aot_log_warning(aot)("Invalid base_archive_name offset/size (out of range): "
618 UINT32_FORMAT " + " UINT32_FORMAT " > " UINT32_FORMAT ,
619 name_offset, name_size, header_size);
620 return false;
621 }
622 const char* name = ((const char*)_header) + _header->_base_archive_name_offset;
623 if (name[name_size - 1] != '\0' || strlen(name) != name_size - 1) {
624 aot_log_warning(aot)("Base archive name is damaged");
625 return false;
626 }
627 if (!os::file_exists(name)) {
628 aot_log_warning(aot)("Base archive %s does not exist", name);
629 return false;
630 }
631 _base_archive_name = name;
632 }
633 }
634
635 return true;
636 }
637 };
638
639 // Return value:
640 // false:
641 // <archive_name> is not a valid archive. *base_archive_name is set to null.
642 // true && (*base_archive_name) == nullptr:
643 // <archive_name> is a valid static archive.
644 // true && (*base_archive_name) != nullptr:
645 // <archive_name> is a valid dynamic archive.
646 bool FileMapInfo::get_base_archive_name_from_header(const char* archive_name,
647 const char** base_archive_name) {
648 FileHeaderHelper file_helper(archive_name, false);
649 *base_archive_name = nullptr;
650
651 if (!file_helper.initialize()) {
652 return false;
653 }
654 GenericCDSFileMapHeader* header = file_helper.get_generic_file_header();
655 switch (header->_magic) {
656 case CDS_PREIMAGE_ARCHIVE_MAGIC:
657 return false; // This is a binary config file, not a proper archive
658 case CDS_DYNAMIC_ARCHIVE_MAGIC:
659 break;
660 default:
661 assert(header->_magic == CDS_ARCHIVE_MAGIC, "must be");
662 if (AutoCreateSharedArchive) {
663 aot_log_warning(aot)("AutoCreateSharedArchive is ignored because %s is a static archive", archive_name);
664 }
665 return true;
666 }
667
668 const char* base = file_helper.base_archive_name();
669 if (base == nullptr) {
670 *base_archive_name = CDSConfig::default_archive_path();
671 } else {
672 *base_archive_name = os::strdup_check_oom(base);
673 }
674
675 return true;
676 }
677
678 bool FileMapInfo::is_preimage_static_archive(const char* file) {
679 FileHeaderHelper file_helper(file, false);
680 if (!file_helper.initialize()) {
681 return false;
682 }
683 return file_helper.is_preimage_static_archive();
684 }
685
686 // Read the FileMapInfo information from the file.
687
688 bool FileMapInfo::init_from_file(int fd) {
689 FileHeaderHelper file_helper(_full_path, _is_static);
690 if (!file_helper.initialize(fd)) {
691 aot_log_warning(aot)("Unable to read the file header.");
692 return false;
693 }
694 GenericCDSFileMapHeader* gen_header = file_helper.get_generic_file_header();
695
696 const char* file_type = CDSConfig::type_of_archive_being_loaded();
697 if (_is_static) {
698 if ((gen_header->_magic == CDS_ARCHIVE_MAGIC) ||
699 (gen_header->_magic == CDS_PREIMAGE_ARCHIVE_MAGIC && CDSConfig::is_dumping_final_static_archive())) {
700 // Good
701 } else {
702 if (CDSConfig::new_aot_flags_used()) {
703 aot_log_warning(aot)("Not a valid %s (%s)", file_type, _full_path);
704 } else {
705 aot_log_warning(aot)("Not a base shared archive: %s", _full_path);
706 }
707 return false;
708 }
709 } else {
710 if (gen_header->_magic != CDS_DYNAMIC_ARCHIVE_MAGIC) {
711 aot_log_warning(aot)("Not a top shared archive: %s", _full_path);
712 return false;
713 }
714 }
715
716 _header = (FileMapHeader*)os::malloc(gen_header->_header_size, mtInternal);
717 os::lseek(fd, 0, SEEK_SET); // reset to begin of the archive
718 size_t size = gen_header->_header_size;
719 size_t n = ::read(fd, (void*)_header, (unsigned int)size);
720 if (n != size) {
721 aot_log_warning(aot)("Failed to read file header from the top archive file\n");
722 return false;
723 }
724
725 if (header()->version() != CURRENT_CDS_ARCHIVE_VERSION) {
726 aot_log_info(aot)("_version expected: 0x%x", CURRENT_CDS_ARCHIVE_VERSION);
727 aot_log_info(aot)(" actual: 0x%x", header()->version());
728 aot_log_warning(aot)("The %s has the wrong version.", file_type);
729 return false;
730 }
731
732 unsigned int base_offset = header()->base_archive_name_offset();
733 unsigned int name_size = header()->base_archive_name_size();
734 unsigned int header_size = header()->header_size();
735 if (base_offset != 0 && name_size != 0) {
736 if (header_size != base_offset + name_size) {
737 aot_log_info(aot)("_header_size: " UINT32_FORMAT, header_size);
738 aot_log_info(aot)("base_archive_name_size: " UINT32_FORMAT, header()->base_archive_name_size());
739 aot_log_info(aot)("base_archive_name_offset: " UINT32_FORMAT, header()->base_archive_name_offset());
740 aot_log_warning(aot)("The %s has an incorrect header size.", file_type);
741 return false;
742 }
743 }
744
745 const char* actual_ident = header()->jvm_ident();
746
747 if (actual_ident[JVM_IDENT_MAX-1] != 0) {
748 aot_log_warning(aot)("JVM version identifier is corrupted.");
749 return false;
750 }
751
752 char expected_ident[JVM_IDENT_MAX];
753 get_header_version(expected_ident);
754 if (strncmp(actual_ident, expected_ident, JVM_IDENT_MAX-1) != 0) {
755 aot_log_info(aot)("_jvm_ident expected: %s", expected_ident);
756 aot_log_info(aot)(" actual: %s", actual_ident);
757 aot_log_warning(aot)("The %s was created by a different"
758 " version or build of HotSpot", file_type);
759 return false;
760 }
761
762 _file_offset = header()->header_size(); // accounts for the size of _base_archive_name
763
764 size_t len = os::lseek(fd, 0, SEEK_END);
765
766 for (int i = 0; i < MetaspaceShared::n_regions; i++) {
767 FileMapRegion* r = region_at(i);
768 if (r->file_offset() > len || len - r->file_offset() < r->used()) {
769 aot_log_warning(aot)("The %s has been truncated.", file_type);
770 return false;
771 }
772 }
773
774 if (!header()->check_must_match_flags()) {
775 return false;
776 }
777
778 return true;
779 }
780
781 void FileMapInfo::seek_to_position(size_t pos) {
782 if (os::lseek(_fd, (long)pos, SEEK_SET) < 0) {
783 aot_log_error(aot)("Unable to seek to position %zu", pos);
784 MetaspaceShared::unrecoverable_loading_error();
785 }
786 }
787
788 // Read the FileMapInfo information from the file.
789 bool FileMapInfo::open_for_read() {
790 if (_file_open) {
791 return true;
792 }
793 const char* file_type = CDSConfig::type_of_archive_being_loaded();
794 const char* info = CDSConfig::is_dumping_final_static_archive() ?
795 "AOTConfiguration file " : "";
796 aot_log_info(aot)("trying to map %s%s", info, _full_path);
797 int fd = os::open(_full_path, O_RDONLY | O_BINARY, 0);
798 if (fd < 0) {
799 if (errno == ENOENT) {
800 aot_log_info(aot)("Specified %s not found (%s)", file_type, _full_path);
801 } else {
802 aot_log_warning(aot)("Failed to open %s (%s)", file_type,
803 os::strerror(errno));
804 }
805 return false;
806 } else {
807 aot_log_info(aot)("Opened %s %s.", file_type, _full_path);
808 }
809
810 _fd = fd;
811 _file_open = true;
812 return true;
813 }
814
815 // Write the FileMapInfo information to the file.
816
817 void FileMapInfo::open_as_output() {
818 if (CDSConfig::new_aot_flags_used()) {
819 if (CDSConfig::is_dumping_preimage_static_archive()) {
820 log_info(aot)("Writing binary AOTConfiguration file: %s", _full_path);
821 } else {
822 log_info(aot)("Writing AOTCache file: %s", _full_path);
823 }
824 } else {
825 aot_log_info(aot)("Dumping shared data to file: %s", _full_path);
826 }
827
828 #ifdef _WINDOWS // On Windows, need WRITE permission to remove the file.
829 chmod(_full_path, _S_IREAD | _S_IWRITE);
830 #endif
831
832 // Use remove() to delete the existing file because, on Unix, this will
833 // allow processes that have it open continued access to the file.
834 remove(_full_path);
835 int fd = os::open(_full_path, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0666);
836 if (fd < 0) {
837 aot_log_error(aot)("Unable to create %s %s: (%s).", CDSConfig::type_of_archive_being_written(), _full_path,
838 os::strerror(errno));
839 MetaspaceShared::writing_error();
840 return;
841 }
842 _fd = fd;
843 _file_open = true;
844
845 // Seek past the header. We will write the header after all regions are written
846 // and their CRCs computed.
847 size_t header_bytes = header()->header_size();
848
849 header_bytes = align_up(header_bytes, MetaspaceShared::core_region_alignment());
850 _file_offset = header_bytes;
851 seek_to_position(_file_offset);
852 }
853
854 // Write the header to the file, seek to the next allocation boundary.
855
856 void FileMapInfo::write_header() {
857 _file_offset = 0;
858 seek_to_position(_file_offset);
859 assert(is_file_position_aligned(), "must be");
860 write_bytes(header(), header()->header_size());
861 }
862
863 size_t FileMapRegion::used_aligned() const {
864 return align_up(used(), MetaspaceShared::core_region_alignment());
865 }
866
867 void FileMapRegion::init(int region_index, size_t mapping_offset, size_t size, bool read_only,
868 bool allow_exec, int crc) {
869 _is_heap_region = HeapShared::is_heap_region(region_index);
870 _is_bitmap_region = (region_index == MetaspaceShared::bm);
871 _mapping_offset = mapping_offset;
872 _used = size;
873 _read_only = read_only;
874 _allow_exec = allow_exec;
875 _crc = crc;
876 _mapped_from_file = false;
877 _mapped_base = nullptr;
878 _in_reserved_space = false;
879 }
880
881 void FileMapRegion::init_oopmap(size_t offset, size_t size_in_bits) {
882 _oopmap_offset = offset;
883 _oopmap_size_in_bits = size_in_bits;
884 }
885
886 void FileMapRegion::init_ptrmap(size_t offset, size_t size_in_bits) {
887 _ptrmap_offset = offset;
888 _ptrmap_size_in_bits = size_in_bits;
889 }
890
891 bool FileMapRegion::check_region_crc(char* base) const {
892 // This function should be called after the region has been properly
893 // loaded into memory via FileMapInfo::map_region() or FileMapInfo::read_region().
894 // I.e., this->mapped_base() must be valid.
895 size_t sz = used();
896 if (sz == 0) {
897 return true;
898 }
899
900 assert(base != nullptr, "must be initialized");
901 int crc = ClassLoader::crc32(0, base, (jint)sz);
902 if (crc != this->crc()) {
903 aot_log_warning(aot)("Checksum verification failed.");
904 return false;
905 }
906 return true;
907 }
908
909 static const char* region_name(int region_index) {
910 static const char* names[] = {
911 "rw", "ro", "bm", "hp", "ac"
912 };
913 const int num_regions = sizeof(names)/sizeof(names[0]);
914 assert(0 <= region_index && region_index < num_regions, "sanity");
915
916 return names[region_index];
917 }
918
919 BitMapView FileMapInfo::bitmap_view(int region_index, bool is_oopmap) {
920 FileMapRegion* r = region_at(region_index);
921 char* bitmap_base = is_static() ? FileMapInfo::current_info()->map_bitmap_region() : FileMapInfo::dynamic_info()->map_bitmap_region();
922 bitmap_base += is_oopmap ? r->oopmap_offset() : r->ptrmap_offset();
923 size_t size_in_bits = is_oopmap ? r->oopmap_size_in_bits() : r->ptrmap_size_in_bits();
924
925 aot_log_debug(aot, reloc)("mapped %s relocation %smap @ " INTPTR_FORMAT " (%zu bits)",
926 region_name(region_index), is_oopmap ? "oop" : "ptr",
927 p2i(bitmap_base), size_in_bits);
928
929 return BitMapView((BitMap::bm_word_t*)(bitmap_base), size_in_bits);
930 }
931
932 BitMapView FileMapInfo::oopmap_view(int region_index) {
933 return bitmap_view(region_index, /*is_oopmap*/true);
934 }
935
936 BitMapView FileMapInfo::ptrmap_view(int region_index) {
937 return bitmap_view(region_index, /*is_oopmap*/false);
938 }
939
940 void FileMapRegion::print(outputStream* st, int region_index) {
941 st->print_cr("============ region ============= %d \"%s\"", region_index, region_name(region_index));
942 st->print_cr("- crc: 0x%08x", _crc);
943 st->print_cr("- read_only: %d", _read_only);
944 st->print_cr("- allow_exec: %d", _allow_exec);
945 st->print_cr("- is_heap_region: %d", _is_heap_region);
946 st->print_cr("- is_bitmap_region: %d", _is_bitmap_region);
947 st->print_cr("- mapped_from_file: %d", _mapped_from_file);
948 st->print_cr("- file_offset: 0x%zx", _file_offset);
949 st->print_cr("- mapping_offset: 0x%zx", _mapping_offset);
950 st->print_cr("- used: %zu", _used);
951 st->print_cr("- oopmap_offset: 0x%zx", _oopmap_offset);
952 st->print_cr("- oopmap_size_in_bits: %zu", _oopmap_size_in_bits);
953 st->print_cr("- ptrmap_offset: 0x%zx", _ptrmap_offset);
954 st->print_cr("- ptrmap_size_in_bits: %zu", _ptrmap_size_in_bits);
955 st->print_cr("- mapped_base: " INTPTR_FORMAT, p2i(_mapped_base));
956 }
957
958 void FileMapInfo::write_region(int region, char* base, size_t size,
959 bool read_only, bool allow_exec) {
960 assert(CDSConfig::is_dumping_archive(), "sanity");
961
962 FileMapRegion* r = region_at(region);
963 char* requested_base;
964 size_t mapping_offset = 0;
965
966 if (region == MetaspaceShared::bm) {
967 requested_base = nullptr; // always null for bm region
968 } else if (size == 0) {
969 // This is an unused region (e.g., a heap region when !INCLUDE_CDS_JAVA_HEAP)
970 requested_base = nullptr;
971 } else if (HeapShared::is_heap_region(region)) {
972 assert(CDSConfig::is_dumping_heap(), "sanity");
973 #if INCLUDE_CDS_JAVA_HEAP
974 assert(!CDSConfig::is_dumping_dynamic_archive(), "must be");
975 requested_base = (char*)ArchiveHeapWriter::requested_address();
976 if (UseCompressedOops) {
977 mapping_offset = (size_t)((address)requested_base - CompressedOops::base());
978 assert((mapping_offset >> CompressedOops::shift()) << CompressedOops::shift() == mapping_offset, "must be");
979 } else {
980 mapping_offset = 0; // not used with !UseCompressedOops
981 }
982 #endif // INCLUDE_CDS_JAVA_HEAP
983 } else {
984 char* requested_SharedBaseAddress = (char*)MetaspaceShared::requested_base_address();
985 requested_base = ArchiveBuilder::current()->to_requested(base);
986 assert(requested_base >= requested_SharedBaseAddress, "must be");
987 mapping_offset = requested_base - requested_SharedBaseAddress;
988 }
989
990 r->set_file_offset(_file_offset);
991 int crc = ClassLoader::crc32(0, base, (jint)size);
992 if (size > 0) {
993 aot_log_info(aot)("Shared file region (%s) %d: %8zu"
994 " bytes, addr " INTPTR_FORMAT " file offset 0x%08" PRIxPTR
995 " crc 0x%08x",
996 region_name(region), region, size, p2i(requested_base), _file_offset, crc);
997 } else {
998 aot_log_info(aot)("Shared file region (%s) %d: %8zu"
999 " bytes", region_name(region), region, size);
1000 }
1001
1002 r->init(region, mapping_offset, size, read_only, allow_exec, crc);
1003
1004 if (base != nullptr) {
1005 write_bytes_aligned(base, size);
1006 }
1007 }
1008
1009 static size_t write_bitmap(const CHeapBitMap* map, char* output, size_t offset) {
1010 size_t size_in_bytes = map->size_in_bytes();
1011 map->write_to((BitMap::bm_word_t*)(output + offset), size_in_bytes);
1012 return offset + size_in_bytes;
1013 }
1014
1015 // The sorting code groups the objects with non-null oop/ptrs together.
1016 // Relevant bitmaps then have lots of leading and trailing zeros, which
1017 // we do not have to store.
1018 size_t FileMapInfo::remove_bitmap_zeros(CHeapBitMap* map) {
1019 BitMap::idx_t first_set = map->find_first_set_bit(0);
1020 BitMap::idx_t last_set = map->find_last_set_bit(0);
1021 size_t old_size = map->size();
1022
1023 // Slice and resize bitmap
1024 map->truncate(first_set, last_set + 1);
1025
1026 assert(map->at(0), "First bit should be set");
1027 assert(map->at(map->size() - 1), "Last bit should be set");
1028 assert(map->size() <= old_size, "sanity");
1029
1030 return first_set;
1031 }
1032
1033 char* FileMapInfo::write_bitmap_region(CHeapBitMap* rw_ptrmap, CHeapBitMap* ro_ptrmap, ArchiveHeapInfo* heap_info,
1034 size_t &size_in_bytes) {
1035 size_t removed_rw_leading_zeros = remove_bitmap_zeros(rw_ptrmap);
1036 size_t removed_ro_leading_zeros = remove_bitmap_zeros(ro_ptrmap);
1037 header()->set_rw_ptrmap_start_pos(removed_rw_leading_zeros);
1038 header()->set_ro_ptrmap_start_pos(removed_ro_leading_zeros);
1039 size_in_bytes = rw_ptrmap->size_in_bytes() + ro_ptrmap->size_in_bytes();
1040
1041 if (heap_info->is_used()) {
1042 // Remove leading and trailing zeros
1043 size_t removed_oop_leading_zeros = remove_bitmap_zeros(heap_info->oopmap());
1044 size_t removed_ptr_leading_zeros = remove_bitmap_zeros(heap_info->ptrmap());
1045 header()->set_heap_oopmap_start_pos(removed_oop_leading_zeros);
1046 header()->set_heap_ptrmap_start_pos(removed_ptr_leading_zeros);
1047
1048 size_in_bytes += heap_info->oopmap()->size_in_bytes();
1049 size_in_bytes += heap_info->ptrmap()->size_in_bytes();
1050 }
1051
1052 // The bitmap region contains up to 4 parts:
1053 // rw_ptrmap: metaspace pointers inside the read-write region
1054 // ro_ptrmap: metaspace pointers inside the read-only region
1055 // heap_info->oopmap(): Java oop pointers in the heap region
1056 // heap_info->ptrmap(): metaspace pointers in the heap region
1057 char* buffer = NEW_C_HEAP_ARRAY(char, size_in_bytes, mtClassShared);
1058 size_t written = 0;
1059
1060 region_at(MetaspaceShared::rw)->init_ptrmap(0, rw_ptrmap->size());
1061 written = write_bitmap(rw_ptrmap, buffer, written);
1062
1063 region_at(MetaspaceShared::ro)->init_ptrmap(written, ro_ptrmap->size());
1064 written = write_bitmap(ro_ptrmap, buffer, written);
1065
1066 if (heap_info->is_used()) {
1067 FileMapRegion* r = region_at(MetaspaceShared::hp);
1068
1069 r->init_oopmap(written, heap_info->oopmap()->size());
1070 written = write_bitmap(heap_info->oopmap(), buffer, written);
1071
1072 r->init_ptrmap(written, heap_info->ptrmap()->size());
1073 written = write_bitmap(heap_info->ptrmap(), buffer, written);
1074 }
1075
1076 write_region(MetaspaceShared::bm, (char*)buffer, size_in_bytes, /*read_only=*/true, /*allow_exec=*/false);
1077 return buffer;
1078 }
1079
1080 size_t FileMapInfo::write_heap_region(ArchiveHeapInfo* heap_info) {
1081 char* buffer_start = heap_info->buffer_start();
1082 size_t buffer_size = heap_info->buffer_byte_size();
1083 write_region(MetaspaceShared::hp, buffer_start, buffer_size, false, false);
1084 header()->set_heap_root_segments(heap_info->heap_root_segments());
1085 return buffer_size;
1086 }
1087
1088 // Dump bytes to file -- at the current file position.
1089
1090 void FileMapInfo::write_bytes(const void* buffer, size_t nbytes) {
1091 assert(_file_open, "must be");
1092 if (!os::write(_fd, buffer, nbytes)) {
1093 // If the shared archive is corrupted, close it and remove it.
1094 close();
1095 remove(_full_path);
1096
1097 if (CDSConfig::is_dumping_preimage_static_archive()) {
1098 MetaspaceShared::writing_error("Unable to write to AOT configuration file.");
1099 } else if (CDSConfig::new_aot_flags_used()) {
1100 MetaspaceShared::writing_error("Unable to write to AOT cache.");
1101 } else {
1102 MetaspaceShared::writing_error("Unable to write to shared archive.");
1103 }
1104 }
1105 _file_offset += nbytes;
1106 }
1107
1108 bool FileMapInfo::is_file_position_aligned() const {
1109 return _file_offset == align_up(_file_offset,
1110 MetaspaceShared::core_region_alignment());
1111 }
1112
1113 // Align file position to an allocation unit boundary.
1114
1115 void FileMapInfo::align_file_position() {
1116 assert(_file_open, "must be");
1117 size_t new_file_offset = align_up(_file_offset,
1118 MetaspaceShared::core_region_alignment());
1119 if (new_file_offset != _file_offset) {
1120 _file_offset = new_file_offset;
1121 // Seek one byte back from the target and write a byte to insure
1122 // that the written file is the correct length.
1123 _file_offset -= 1;
1124 seek_to_position(_file_offset);
1125 char zero = 0;
1126 write_bytes(&zero, 1);
1127 }
1128 }
1129
1130
1131 // Dump bytes to file -- at the current file position.
1132
1133 void FileMapInfo::write_bytes_aligned(const void* buffer, size_t nbytes) {
1134 align_file_position();
1135 write_bytes(buffer, nbytes);
1136 align_file_position();
1137 }
1138
1139 // Close the shared archive file. This does NOT unmap mapped regions.
1140
1141 void FileMapInfo::close() {
1142 if (_file_open) {
1143 if (::close(_fd) < 0) {
1144 MetaspaceShared::unrecoverable_loading_error("Unable to close the shared archive file.");
1145 }
1146 _file_open = false;
1147 _fd = -1;
1148 }
1149 }
1150
1151 /*
1152 * Same as os::map_memory() but also pretouches if AlwaysPreTouch is enabled.
1153 */
1154 static char* map_memory(int fd, const char* file_name, size_t file_offset,
1155 char *addr, size_t bytes, bool read_only,
1156 bool allow_exec, MemTag mem_tag) {
1157 char* mem = os::map_memory(fd, file_name, file_offset, addr, bytes,
1158 mem_tag, AlwaysPreTouch ? false : read_only,
1159 allow_exec);
1160 if (mem != nullptr && AlwaysPreTouch) {
1161 os::pretouch_memory(mem, mem + bytes);
1162 }
1163 return mem;
1164 }
1165
1166 // JVM/TI RedefineClasses() support:
1167 // Remap the shared readonly space to shared readwrite, private.
1168 bool FileMapInfo::remap_shared_readonly_as_readwrite() {
1169 int idx = MetaspaceShared::ro;
1170 FileMapRegion* r = region_at(idx);
1171 if (!r->read_only()) {
1172 // the space is already readwrite so we are done
1173 return true;
1174 }
1175 size_t size = r->used_aligned();
1176 if (!open_for_read()) {
1177 return false;
1178 }
1179 char *addr = r->mapped_base();
1180 // This path should not be reached for Windows; see JDK-8222379.
1181 assert(WINDOWS_ONLY(false) NOT_WINDOWS(true), "Don't call on Windows");
1182 // Replace old mapping with new one that is writable.
1183 char *base = os::map_memory(_fd, _full_path, r->file_offset(),
1184 addr, size, mtNone, false /* !read_only */,
1185 r->allow_exec());
1186 close();
1187 // These have to be errors because the shared region is now unmapped.
1188 if (base == nullptr) {
1189 aot_log_error(aot)("Unable to remap shared readonly space (errno=%d).", errno);
1190 vm_exit(1);
1191 }
1192 if (base != addr) {
1193 aot_log_error(aot)("Unable to remap shared readonly space (errno=%d).", errno);
1194 vm_exit(1);
1195 }
1196 r->set_read_only(false);
1197 return true;
1198 }
1199
1200 // Memory map a region in the address space.
1201 static const char* shared_region_name[] = { "ReadWrite", "ReadOnly", "Bitmap", "Heap", "Code" };
1202
1203 MapArchiveResult FileMapInfo::map_regions(int regions[], int num_regions, char* mapped_base_address, ReservedSpace rs) {
1204 DEBUG_ONLY(FileMapRegion* last_region = nullptr);
1205 intx addr_delta = mapped_base_address - header()->requested_base_address();
1206
1207 // Make sure we don't attempt to use header()->mapped_base_address() unless
1208 // it's been successfully mapped.
1209 DEBUG_ONLY(header()->set_mapped_base_address((char*)(uintptr_t)0xdeadbeef);)
1210
1211 for (int i = 0; i < num_regions; i++) {
1212 int idx = regions[i];
1213 MapArchiveResult result = map_region(idx, addr_delta, mapped_base_address, rs);
1214 if (result != MAP_ARCHIVE_SUCCESS) {
1215 return result;
1216 }
1217 FileMapRegion* r = region_at(idx);
1218 DEBUG_ONLY(if (last_region != nullptr) {
1219 // Ensure that the OS won't be able to allocate new memory spaces between any mapped
1220 // regions, or else it would mess up the simple comparison in MetaspaceObj::is_shared().
1221 assert(r->mapped_base() == last_region->mapped_end(), "must have no gaps");
1222 }
1223 last_region = r;)
1224 aot_log_info(aot)("Mapped %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)", is_static() ? "static " : "dynamic",
1225 idx, p2i(r->mapped_base()), p2i(r->mapped_end()),
1226 shared_region_name[idx]);
1227
1228 }
1229
1230 header()->set_mapped_base_address(header()->requested_base_address() + addr_delta);
1231 if (addr_delta != 0 && !relocate_pointers_in_core_regions(addr_delta)) {
1232 return MAP_ARCHIVE_OTHER_FAILURE;
1233 }
1234
1235 return MAP_ARCHIVE_SUCCESS;
1236 }
1237
1238 bool FileMapInfo::read_region(int i, char* base, size_t size, bool do_commit) {
1239 FileMapRegion* r = region_at(i);
1240 if (do_commit) {
1241 aot_log_info(aot)("Commit %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)%s",
1242 is_static() ? "static " : "dynamic", i, p2i(base), p2i(base + size),
1243 shared_region_name[i], r->allow_exec() ? " exec" : "");
1244 if (!os::commit_memory(base, size, r->allow_exec())) {
1245 aot_log_error(aot)("Failed to commit %s region #%d (%s)", is_static() ? "static " : "dynamic",
1246 i, shared_region_name[i]);
1247 return false;
1248 }
1249 }
1250 if (os::lseek(_fd, (long)r->file_offset(), SEEK_SET) != (int)r->file_offset() ||
1251 read_bytes(base, size) != size) {
1252 return false;
1253 }
1254
1255 if (VerifySharedSpaces && !r->check_region_crc(base)) {
1256 return false;
1257 }
1258
1259 r->set_mapped_from_file(false);
1260 r->set_mapped_base(base);
1261
1262 return true;
1263 }
1264
1265 MapArchiveResult FileMapInfo::map_region(int i, intx addr_delta, char* mapped_base_address, ReservedSpace rs) {
1266 assert(!HeapShared::is_heap_region(i), "sanity");
1267 FileMapRegion* r = region_at(i);
1268 size_t size = r->used_aligned();
1269 char *requested_addr = mapped_base_address + r->mapping_offset();
1270 assert(!is_mapped(), "must be not mapped yet");
1271 assert(requested_addr != nullptr, "must be specified");
1272
1273 r->set_mapped_from_file(false);
1274 r->set_in_reserved_space(false);
1275
1276 if (MetaspaceShared::use_windows_memory_mapping()) {
1277 // Windows cannot remap read-only shared memory to read-write when required for
1278 // RedefineClasses, which is also used by JFR. Always map windows regions as RW.
1279 r->set_read_only(false);
1280 } else if (JvmtiExport::can_modify_any_class() || JvmtiExport::can_walk_any_space() ||
1281 Arguments::has_jfr_option()) {
1282 // If a tool agent is in use (debugging enabled), or JFR, we must map the address space RW
1283 r->set_read_only(false);
1284 } else if (addr_delta != 0) {
1285 r->set_read_only(false); // Need to patch the pointers
1286 }
1287
1288 if (MetaspaceShared::use_windows_memory_mapping() && rs.is_reserved()) {
1289 // This is the second time we try to map the archive(s). We have already created a ReservedSpace
1290 // that covers all the FileMapRegions to ensure all regions can be mapped. However, Windows
1291 // can't mmap into a ReservedSpace, so we just ::read() the data. We're going to patch all the
1292 // regions anyway, so there's no benefit for mmap anyway.
1293 if (!read_region(i, requested_addr, size, /* do_commit = */ true)) {
1294 MetaspaceShared::report_loading_error("Failed to read %s shared space into reserved space at " INTPTR_FORMAT,
1295 shared_region_name[i], p2i(requested_addr));
1296 return MAP_ARCHIVE_OTHER_FAILURE; // oom or I/O error.
1297 } else {
1298 assert(r->mapped_base() != nullptr, "must be initialized");
1299 }
1300 } else {
1301 // Note that this may either be a "fresh" mapping into unreserved address
1302 // space (Windows, first mapping attempt), or a mapping into pre-reserved
1303 // space (Posix). See also comment in MetaspaceShared::map_archives().
1304 char* base = map_memory(_fd, _full_path, r->file_offset(),
1305 requested_addr, size, r->read_only(),
1306 r->allow_exec(), mtClassShared);
1307 if (base != requested_addr) {
1308 MetaspaceShared::report_loading_error("Unable to map %s shared space at " INTPTR_FORMAT,
1309 shared_region_name[i], p2i(requested_addr));
1310 _memory_mapping_failed = true;
1311 return MAP_ARCHIVE_MMAP_FAILURE;
1312 }
1313
1314 if (VerifySharedSpaces && !r->check_region_crc(requested_addr)) {
1315 return MAP_ARCHIVE_OTHER_FAILURE;
1316 }
1317
1318 r->set_mapped_from_file(true);
1319 r->set_mapped_base(requested_addr);
1320 }
1321
1322 if (rs.is_reserved()) {
1323 char* mapped_base = r->mapped_base();
1324 assert(rs.base() <= mapped_base && mapped_base + size <= rs.end(),
1325 PTR_FORMAT " <= " PTR_FORMAT " < " PTR_FORMAT " <= " PTR_FORMAT,
1326 p2i(rs.base()), p2i(mapped_base), p2i(mapped_base + size), p2i(rs.end()));
1327 r->set_in_reserved_space(rs.is_reserved());
1328 }
1329 return MAP_ARCHIVE_SUCCESS;
1330 }
1331
1332 // The return value is the location of the archive relocation bitmap.
1333 char* FileMapInfo::map_bitmap_region() {
1334 FileMapRegion* r = region_at(MetaspaceShared::bm);
1335 if (r->mapped_base() != nullptr) {
1336 return r->mapped_base();
1337 }
1338 bool read_only = true, allow_exec = false;
1339 char* requested_addr = nullptr; // allow OS to pick any location
1340 char* bitmap_base = map_memory(_fd, _full_path, r->file_offset(),
1341 requested_addr, r->used_aligned(), read_only, allow_exec, mtClassShared);
1342 if (bitmap_base == nullptr) {
1343 MetaspaceShared::report_loading_error("failed to map relocation bitmap");
1344 return nullptr;
1345 }
1346
1347 if (VerifySharedSpaces && !r->check_region_crc(bitmap_base)) {
1348 aot_log_error(aot)("relocation bitmap CRC error");
1349 if (!os::unmap_memory(bitmap_base, r->used_aligned())) {
1350 fatal("os::unmap_memory of relocation bitmap failed");
1351 }
1352 return nullptr;
1353 }
1354
1355 r->set_mapped_from_file(true);
1356 r->set_mapped_base(bitmap_base);
1357 aot_log_info(aot)("Mapped %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)",
1358 is_static() ? "static " : "dynamic",
1359 MetaspaceShared::bm, p2i(r->mapped_base()), p2i(r->mapped_end()),
1360 shared_region_name[MetaspaceShared::bm]);
1361 return bitmap_base;
1362 }
1363
1364 bool FileMapInfo::map_aot_code_region(ReservedSpace rs) {
1365 FileMapRegion* r = region_at(MetaspaceShared::ac);
1366 assert(r->used() > 0 && r->used_aligned() == rs.size(), "must be");
1367
1368 char* requested_base = rs.base();
1369 assert(requested_base != nullptr, "should be inside code cache");
1370
1371 char* mapped_base;
1372 if (MetaspaceShared::use_windows_memory_mapping()) {
1373 if (!read_region(MetaspaceShared::ac, requested_base, r->used_aligned(), /* do_commit = */ true)) {
1374 MetaspaceShared::report_loading_error("Failed to read aot code shared space into reserved space at " INTPTR_FORMAT,
1375 p2i(requested_base));
1376 return false;
1377 }
1378 mapped_base = requested_base;
1379 } else {
1380 // We do not execute in-place in the AOT code region.
1381 // AOT code is copied to the CodeCache for execution.
1382 bool read_only = false, allow_exec = false;
1383 mapped_base = map_memory(_fd, _full_path, r->file_offset(),
1384 requested_base, r->used_aligned(), read_only, allow_exec, mtClassShared);
1385 }
1386 if (mapped_base == nullptr) {
1387 MetaspaceShared::report_loading_error("failed to map aot code region");
1388 return false;
1389 } else {
1390 assert(mapped_base == requested_base, "must be");
1391 r->set_mapped_from_file(true);
1392 r->set_mapped_base(mapped_base);
1393 aot_log_info(aot)("Mapped static region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)",
1394 MetaspaceShared::ac, p2i(r->mapped_base()), p2i(r->mapped_end()),
1395 shared_region_name[MetaspaceShared::ac]);
1396 return true;
1397 }
1398 }
1399
1400 class SharedDataRelocationTask : public ArchiveWorkerTask {
1401 private:
1402 BitMapView* const _rw_bm;
1403 BitMapView* const _ro_bm;
1404 SharedDataRelocator* const _rw_reloc;
1405 SharedDataRelocator* const _ro_reloc;
1406
1407 public:
1408 SharedDataRelocationTask(BitMapView* rw_bm, BitMapView* ro_bm, SharedDataRelocator* rw_reloc, SharedDataRelocator* ro_reloc) :
1409 ArchiveWorkerTask("Shared Data Relocation"),
1410 _rw_bm(rw_bm), _ro_bm(ro_bm), _rw_reloc(rw_reloc), _ro_reloc(ro_reloc) {}
1411
1412 void work(int chunk, int max_chunks) override {
1413 work_on(chunk, max_chunks, _rw_bm, _rw_reloc);
1414 work_on(chunk, max_chunks, _ro_bm, _ro_reloc);
1415 }
1416
1417 void work_on(int chunk, int max_chunks, BitMapView* bm, SharedDataRelocator* reloc) {
1418 BitMap::idx_t size = bm->size();
1419 BitMap::idx_t start = MIN2(size, size * chunk / max_chunks);
1420 BitMap::idx_t end = MIN2(size, size * (chunk + 1) / max_chunks);
1421 assert(end > start, "Sanity: no empty slices");
1422 bm->iterate(reloc, start, end);
1423 }
1424 };
1425
1426 // This is called when we cannot map the archive at the requested[ base address (usually 0x800000000).
1427 // We relocate all pointers in the 2 core regions (ro, rw).
1428 bool FileMapInfo::relocate_pointers_in_core_regions(intx addr_delta) {
1429 aot_log_debug(aot, reloc)("runtime archive relocation start");
1430 char* bitmap_base = map_bitmap_region();
1431
1432 if (bitmap_base == nullptr) {
1433 return false; // OOM, or CRC check failure
1434 } else {
1435 BitMapView rw_ptrmap = ptrmap_view(MetaspaceShared::rw);
1436 BitMapView ro_ptrmap = ptrmap_view(MetaspaceShared::ro);
1437
1438 FileMapRegion* rw_region = first_core_region();
1439 FileMapRegion* ro_region = last_core_region();
1440
1441 // Patch all pointers inside the RW region
1442 address rw_patch_base = (address)rw_region->mapped_base();
1443 address rw_patch_end = (address)rw_region->mapped_end();
1444
1445 // Patch all pointers inside the RO region
1446 address ro_patch_base = (address)ro_region->mapped_base();
1447 address ro_patch_end = (address)ro_region->mapped_end();
1448
1449 // the current value of the pointers to be patched must be within this
1450 // range (i.e., must be between the requested base address and the address of the current archive).
1451 // Note: top archive may point to objects in the base archive, but not the other way around.
1452 address valid_old_base = (address)header()->requested_base_address();
1453 address valid_old_end = valid_old_base + mapping_end_offset();
1454
1455 // after patching, the pointers must point inside this range
1456 // (the requested location of the archive, as mapped at runtime).
1457 address valid_new_base = (address)header()->mapped_base_address();
1458 address valid_new_end = (address)mapped_end();
1459
1460 SharedDataRelocator rw_patcher((address*)rw_patch_base + header()->rw_ptrmap_start_pos(), (address*)rw_patch_end, valid_old_base, valid_old_end,
1461 valid_new_base, valid_new_end, addr_delta);
1462 SharedDataRelocator ro_patcher((address*)ro_patch_base + header()->ro_ptrmap_start_pos(), (address*)ro_patch_end, valid_old_base, valid_old_end,
1463 valid_new_base, valid_new_end, addr_delta);
1464
1465 if (AOTCacheParallelRelocation) {
1466 ArchiveWorkers workers;
1467 SharedDataRelocationTask task(&rw_ptrmap, &ro_ptrmap, &rw_patcher, &ro_patcher);
1468 workers.run_task(&task);
1469 } else {
1470 rw_ptrmap.iterate(&rw_patcher);
1471 ro_ptrmap.iterate(&ro_patcher);
1472 }
1473
1474 // The MetaspaceShared::bm region will be unmapped in MetaspaceShared::initialize_shared_spaces().
1475
1476 aot_log_debug(aot, reloc)("runtime archive relocation done");
1477 return true;
1478 }
1479 }
1480
1481 size_t FileMapInfo::read_bytes(void* buffer, size_t count) {
1482 assert(_file_open, "Archive file is not open");
1483 size_t n = ::read(_fd, buffer, (unsigned int)count);
1484 if (n != count) {
1485 // Close the file if there's a problem reading it.
1486 close();
1487 return 0;
1488 }
1489 _file_offset += count;
1490 return count;
1491 }
1492
1493 // Get the total size in bytes of a read only region
1494 size_t FileMapInfo::readonly_total() {
1495 size_t total = 0;
1496 if (current_info() != nullptr) {
1497 FileMapRegion* r = FileMapInfo::current_info()->region_at(MetaspaceShared::ro);
1498 if (r->read_only()) total += r->used();
1499 }
1500 if (dynamic_info() != nullptr) {
1501 FileMapRegion* r = FileMapInfo::dynamic_info()->region_at(MetaspaceShared::ro);
1502 if (r->read_only()) total += r->used();
1503 }
1504 return total;
1505 }
1506
1507 #if INCLUDE_CDS_JAVA_HEAP
1508 MemRegion FileMapInfo::_mapped_heap_memregion;
1509
1510 bool FileMapInfo::has_heap_region() {
1511 return (region_at(MetaspaceShared::hp)->used() > 0);
1512 }
1513
1514 // Returns the address range of the archived heap region computed using the
1515 // current oop encoding mode. This range may be different than the one seen at
1516 // dump time due to encoding mode differences. The result is used in determining
1517 // if/how these regions should be relocated at run time.
1518 MemRegion FileMapInfo::get_heap_region_requested_range() {
1519 FileMapRegion* r = region_at(MetaspaceShared::hp);
1520 size_t size = r->used();
1521 assert(size > 0, "must have non-empty heap region");
1522
1523 address start = heap_region_requested_address();
1524 address end = start + size;
1525 aot_log_info(aot)("Requested heap region [" INTPTR_FORMAT " - " INTPTR_FORMAT "] = %8zu bytes",
1526 p2i(start), p2i(end), size);
1527
1528 return MemRegion((HeapWord*)start, (HeapWord*)end);
1529 }
1530
1531 void FileMapInfo::map_or_load_heap_region() {
1532 bool success = false;
1533
1534 if (can_use_heap_region()) {
1535 if (ArchiveHeapLoader::can_map()) {
1536 success = map_heap_region();
1537 } else if (ArchiveHeapLoader::can_load()) {
1538 success = ArchiveHeapLoader::load_heap_region(this);
1539 } else {
1540 if (!UseCompressedOops && !ArchiveHeapLoader::can_map()) {
1541 MetaspaceShared::report_loading_error("Cannot use CDS heap data. Selected GC not compatible -XX:-UseCompressedOops");
1542 } else {
1543 MetaspaceShared::report_loading_error("Cannot use CDS heap data. UseEpsilonGC, UseG1GC, UseSerialGC, UseParallelGC, or UseShenandoahGC are required.");
1544 }
1545 }
1546 }
1547
1548 if (!success) {
1549 if (CDSConfig::is_using_aot_linked_classes()) {
1550 // It's too late to recover -- we have already committed to use the archived metaspace objects, but
1551 // the archived heap objects cannot be loaded, so we don't have the archived FMG to guarantee that
1552 // all AOT-linked classes are visible.
1553 //
1554 // We get here because the heap is too small. The app will fail anyway. So let's quit.
1555 aot_log_error(aot)("%s has aot-linked classes but the archived "
1556 "heap objects cannot be loaded. Try increasing your heap size.",
1557 CDSConfig::type_of_archive_being_loaded());
1558 MetaspaceShared::unrecoverable_loading_error();
1559 }
1560 CDSConfig::stop_using_full_module_graph("archive heap loading failed");
1561 }
1562 }
1563
1564 bool FileMapInfo::can_use_heap_region() {
1565 if (!has_heap_region()) {
1566 return false;
1567 }
1568 if (JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()) {
1569 ShouldNotReachHere(); // CDS should have been disabled.
1570 // The archived objects are mapped at JVM start-up, but we don't know if
1571 // j.l.String or j.l.Class might be replaced by the ClassFileLoadHook,
1572 // which would make the archived String or mirror objects invalid. Let's be safe and not
1573 // use the archived objects. These 2 classes are loaded during the JVMTI "early" stage.
1574 //
1575 // If JvmtiExport::has_early_class_hook_env() is false, the classes of some objects
1576 // in the archived subgraphs may be replaced by the ClassFileLoadHook. But that's OK
1577 // because we won't install an archived object subgraph if the klass of any of the
1578 // referenced objects are replaced. See HeapShared::initialize_from_archived_subgraph().
1579 }
1580
1581 // We pre-compute narrow Klass IDs with the runtime mapping start intended to be the base, and a shift of
1582 // ArchiveBuilder::precomputed_narrow_klass_shift. We enforce this encoding at runtime (see
1583 // CompressedKlassPointers::initialize_for_given_encoding()). Therefore, the following assertions must
1584 // hold:
1585 address archive_narrow_klass_base = (address)header()->mapped_base_address();
1586 const int archive_narrow_klass_pointer_bits = header()->narrow_klass_pointer_bits();
1587 const int archive_narrow_klass_shift = header()->narrow_klass_shift();
1588
1589 aot_log_info(aot)("CDS archive was created with max heap size = %zuM, and the following configuration:",
1590 max_heap_size()/M);
1591 aot_log_info(aot)(" narrow_klass_base at mapping start address, narrow_klass_pointer_bits = %d, narrow_klass_shift = %d",
1592 archive_narrow_klass_pointer_bits, archive_narrow_klass_shift);
1593 aot_log_info(aot)(" narrow_oop_mode = %d, narrow_oop_base = " PTR_FORMAT ", narrow_oop_shift = %d",
1594 narrow_oop_mode(), p2i(narrow_oop_base()), narrow_oop_shift());
1595 aot_log_info(aot)("The current max heap size = %zuM, G1HeapRegion::GrainBytes = %zu",
1596 MaxHeapSize/M, G1HeapRegion::GrainBytes);
1597 aot_log_info(aot)(" narrow_klass_base = " PTR_FORMAT ", arrow_klass_pointer_bits = %d, narrow_klass_shift = %d",
1598 p2i(CompressedKlassPointers::base()), CompressedKlassPointers::narrow_klass_pointer_bits(), CompressedKlassPointers::shift());
1599 aot_log_info(aot)(" narrow_oop_mode = %d, narrow_oop_base = " PTR_FORMAT ", narrow_oop_shift = %d",
1600 CompressedOops::mode(), p2i(CompressedOops::base()), CompressedOops::shift());
1601 aot_log_info(aot)(" heap range = [" PTR_FORMAT " - " PTR_FORMAT "]",
1602 UseCompressedOops ? p2i(CompressedOops::begin()) :
1603 UseG1GC ? p2i((address)G1CollectedHeap::heap()->reserved().start()) : 0L,
1604 UseCompressedOops ? p2i(CompressedOops::end()) :
1605 UseG1GC ? p2i((address)G1CollectedHeap::heap()->reserved().end()) : 0L);
1606
1607 int err = 0;
1608 if ( archive_narrow_klass_base != CompressedKlassPointers::base() ||
1609 (err = 1, archive_narrow_klass_pointer_bits != CompressedKlassPointers::narrow_klass_pointer_bits()) ||
1610 (err = 2, archive_narrow_klass_shift != CompressedKlassPointers::shift()) ) {
1611 stringStream ss;
1612 switch (err) {
1613 case 0:
1614 ss.print("Unexpected encoding base encountered (" PTR_FORMAT ", expected " PTR_FORMAT ")",
1615 p2i(CompressedKlassPointers::base()), p2i(archive_narrow_klass_base));
1616 break;
1617 case 1:
1618 ss.print("Unexpected narrow Klass bit length encountered (%d, expected %d)",
1619 CompressedKlassPointers::narrow_klass_pointer_bits(), archive_narrow_klass_pointer_bits);
1620 break;
1621 case 2:
1622 ss.print("Unexpected narrow Klass shift encountered (%d, expected %d)",
1623 CompressedKlassPointers::shift(), archive_narrow_klass_shift);
1624 break;
1625 default:
1626 ShouldNotReachHere();
1627 };
1628 if (CDSConfig::new_aot_flags_used()) {
1629 LogTarget(Info, aot) lt;
1630 if (lt.is_enabled()) {
1631 LogStream ls(lt);
1632 ls.print_raw(ss.base());
1633 header()->print(&ls);
1634 }
1635 } else {
1636 LogTarget(Info, cds) lt;
1637 if (lt.is_enabled()) {
1638 LogStream ls(lt);
1639 ls.print_raw(ss.base());
1640 header()->print(&ls);
1641 }
1642 }
1643 assert(false, "%s", ss.base());
1644 }
1645
1646 return true;
1647 }
1648
1649 // The actual address of this region during dump time.
1650 address FileMapInfo::heap_region_dumptime_address() {
1651 FileMapRegion* r = region_at(MetaspaceShared::hp);
1652 assert(CDSConfig::is_using_archive(), "runtime only");
1653 assert(is_aligned(r->mapping_offset(), sizeof(HeapWord)), "must be");
1654 if (UseCompressedOops) {
1655 return /*dumptime*/ (address)((uintptr_t)narrow_oop_base() + r->mapping_offset());
1656 } else {
1657 return heap_region_requested_address();
1658 }
1659 }
1660
1661 // The address where this region can be mapped into the runtime heap without
1662 // patching any of the pointers that are embedded in this region.
1663 address FileMapInfo::heap_region_requested_address() {
1664 assert(CDSConfig::is_using_archive(), "runtime only");
1665 FileMapRegion* r = region_at(MetaspaceShared::hp);
1666 assert(is_aligned(r->mapping_offset(), sizeof(HeapWord)), "must be");
1667 assert(ArchiveHeapLoader::can_use(), "GC must support mapping or loading");
1668 if (UseCompressedOops) {
1669 // We can avoid relocation if each region's offset from the runtime CompressedOops::base()
1670 // is the same as its offset from the CompressedOops::base() during dumptime.
1671 // Note that CompressedOops::base() may be different between dumptime and runtime.
1672 //
1673 // Example:
1674 // Dumptime base = 0x1000 and shift is 0. We have a region at address 0x2000. There's a
1675 // narrowOop P stored in this region that points to an object at address 0x2200.
1676 // P's encoded value is 0x1200.
1677 //
1678 // Runtime base = 0x4000 and shift is also 0. If we map this region at 0x5000, then
1679 // the value P can remain 0x1200. The decoded address = (0x4000 + (0x1200 << 0)) = 0x5200,
1680 // which is the runtime location of the referenced object.
1681 return /*runtime*/ (address)((uintptr_t)CompressedOops::base() + r->mapping_offset());
1682 } else {
1683 // This was the hard-coded requested base address used at dump time. With uncompressed oops,
1684 // the heap range is assigned by the OS so we will most likely have to relocate anyway, no matter
1685 // what base address was picked at duump time.
1686 return (address)ArchiveHeapWriter::NOCOOPS_REQUESTED_BASE;
1687 }
1688 }
1689
1690 bool FileMapInfo::map_heap_region() {
1691 if (map_heap_region_impl()) {
1692 #ifdef ASSERT
1693 // The "old" regions must be parsable -- we cannot have any unused space
1694 // at the start of the lowest G1 region that contains archived objects.
1695 assert(is_aligned(_mapped_heap_memregion.start(), G1HeapRegion::GrainBytes), "must be");
1696
1697 // Make sure we map at the very top of the heap - see comments in
1698 // init_heap_region_relocation().
1699 MemRegion heap_range = G1CollectedHeap::heap()->reserved();
1700 assert(heap_range.contains(_mapped_heap_memregion), "must be");
1701
1702 address heap_end = (address)heap_range.end();
1703 address mapped_heap_region_end = (address)_mapped_heap_memregion.end();
1704 assert(heap_end >= mapped_heap_region_end, "must be");
1705 assert(heap_end - mapped_heap_region_end < (intx)(G1HeapRegion::GrainBytes),
1706 "must be at the top of the heap to avoid fragmentation");
1707 #endif
1708
1709 ArchiveHeapLoader::set_mapped();
1710 return true;
1711 } else {
1712 return false;
1713 }
1714 }
1715
1716 bool FileMapInfo::map_heap_region_impl() {
1717 assert(UseG1GC, "the following code assumes G1");
1718
1719 FileMapRegion* r = region_at(MetaspaceShared::hp);
1720 size_t size = r->used();
1721 if (size == 0) {
1722 return false; // no archived java heap data
1723 }
1724
1725 size_t word_size = size / HeapWordSize;
1726 address requested_start = heap_region_requested_address();
1727
1728 aot_log_info(aot)("Preferred address to map heap data (to avoid relocation) is " INTPTR_FORMAT, p2i(requested_start));
1729
1730 // allocate from java heap
1731 HeapWord* start = G1CollectedHeap::heap()->alloc_archive_region(word_size, (HeapWord*)requested_start);
1732 if (start == nullptr) {
1733 MetaspaceShared::report_loading_error("UseSharedSpaces: Unable to allocate java heap region for archive heap.");
1734 return false;
1735 }
1736
1737 _mapped_heap_memregion = MemRegion(start, word_size);
1738
1739 // Map the archived heap data. No need to call MemTracker::record_virtual_memory_tag()
1740 // for mapped region as it is part of the reserved java heap, which is already recorded.
1741 char* addr = (char*)_mapped_heap_memregion.start();
1742 char* base;
1743
1744 if (MetaspaceShared::use_windows_memory_mapping() || UseLargePages) {
1745 // With UseLargePages, memory mapping may fail on some OSes if the size is not
1746 // large page aligned, so let's use read() instead. In this case, the memory region
1747 // is already commited by G1 so we don't need to commit it again.
1748 if (!read_region(MetaspaceShared::hp, addr,
1749 align_up(_mapped_heap_memregion.byte_size(), os::vm_page_size()),
1750 /* do_commit = */ !UseLargePages)) {
1751 dealloc_heap_region();
1752 aot_log_error(aot)("Failed to read archived heap region into " INTPTR_FORMAT, p2i(addr));
1753 return false;
1754 }
1755 // Checks for VerifySharedSpaces is already done inside read_region()
1756 base = addr;
1757 } else {
1758 base = map_memory(_fd, _full_path, r->file_offset(),
1759 addr, _mapped_heap_memregion.byte_size(), r->read_only(),
1760 r->allow_exec(), mtJavaHeap);
1761 if (base == nullptr || base != addr) {
1762 dealloc_heap_region();
1763 MetaspaceShared::report_loading_error("UseSharedSpaces: Unable to map at required address in java heap. "
1764 INTPTR_FORMAT ", size = %zu bytes",
1765 p2i(addr), _mapped_heap_memregion.byte_size());
1766 return false;
1767 }
1768
1769 if (VerifySharedSpaces && !r->check_region_crc(base)) {
1770 dealloc_heap_region();
1771 MetaspaceShared::report_loading_error("UseSharedSpaces: mapped heap region is corrupt");
1772 return false;
1773 }
1774 }
1775
1776 r->set_mapped_base(base);
1777
1778 // If the requested range is different from the range allocated by GC, then
1779 // the pointers need to be patched.
1780 address mapped_start = (address) _mapped_heap_memregion.start();
1781 ptrdiff_t delta = mapped_start - requested_start;
1782 if (UseCompressedOops &&
1783 (narrow_oop_mode() != CompressedOops::mode() ||
1784 narrow_oop_shift() != CompressedOops::shift())) {
1785 _heap_pointers_need_patching = true;
1786 }
1787 if (delta != 0) {
1788 _heap_pointers_need_patching = true;
1789 }
1790 ArchiveHeapLoader::init_mapped_heap_info(mapped_start, delta, narrow_oop_shift());
1791
1792 if (_heap_pointers_need_patching) {
1793 char* bitmap_base = map_bitmap_region();
1794 if (bitmap_base == nullptr) {
1795 MetaspaceShared::report_loading_error("CDS heap cannot be used because bitmap region cannot be mapped");
1796 dealloc_heap_region();
1797 _heap_pointers_need_patching = false;
1798 return false;
1799 }
1800 }
1801 aot_log_info(aot)("Heap data mapped at " INTPTR_FORMAT ", size = %8zu bytes",
1802 p2i(mapped_start), _mapped_heap_memregion.byte_size());
1803 aot_log_info(aot)("CDS heap data relocation delta = %zd bytes", delta);
1804 return true;
1805 }
1806
1807 narrowOop FileMapInfo::encoded_heap_region_dumptime_address() {
1808 assert(CDSConfig::is_using_archive(), "runtime only");
1809 assert(UseCompressedOops, "sanity");
1810 FileMapRegion* r = region_at(MetaspaceShared::hp);
1811 return CompressedOops::narrow_oop_cast(r->mapping_offset() >> narrow_oop_shift());
1812 }
1813
1814 void FileMapInfo::patch_heap_embedded_pointers() {
1815 if (!ArchiveHeapLoader::is_mapped() || !_heap_pointers_need_patching) {
1816 return;
1817 }
1818
1819 char* bitmap_base = map_bitmap_region();
1820 assert(bitmap_base != nullptr, "must have already been mapped");
1821
1822 FileMapRegion* r = region_at(MetaspaceShared::hp);
1823 ArchiveHeapLoader::patch_embedded_pointers(
1824 this, _mapped_heap_memregion,
1825 (address)(region_at(MetaspaceShared::bm)->mapped_base()) + r->oopmap_offset(),
1826 r->oopmap_size_in_bits());
1827 }
1828
1829 void FileMapInfo::fixup_mapped_heap_region() {
1830 if (ArchiveHeapLoader::is_mapped()) {
1831 assert(!_mapped_heap_memregion.is_empty(), "sanity");
1832
1833 // Populate the archive regions' G1BlockOffsetTables. That ensures
1834 // fast G1BlockOffsetTable::block_start operations for any given address
1835 // within the archive regions when trying to find start of an object
1836 // (e.g. during card table scanning).
1837 G1CollectedHeap::heap()->populate_archive_regions_bot(_mapped_heap_memregion);
1838 }
1839 }
1840
1841 // dealloc the archive regions from java heap
1842 void FileMapInfo::dealloc_heap_region() {
1843 G1CollectedHeap::heap()->dealloc_archive_regions(_mapped_heap_memregion);
1844 }
1845 #endif // INCLUDE_CDS_JAVA_HEAP
1846
1847 void FileMapInfo::unmap_regions(int regions[], int num_regions) {
1848 for (int r = 0; r < num_regions; r++) {
1849 int idx = regions[r];
1850 unmap_region(idx);
1851 }
1852 }
1853
1854 // Unmap a memory region in the address space.
1855
1856 void FileMapInfo::unmap_region(int i) {
1857 FileMapRegion* r = region_at(i);
1858 char* mapped_base = r->mapped_base();
1859 size_t size = r->used_aligned();
1860
1861 if (mapped_base != nullptr) {
1862 if (size > 0 && r->mapped_from_file()) {
1863 aot_log_info(aot)("Unmapping region #%d at base " INTPTR_FORMAT " (%s)", i, p2i(mapped_base),
1864 shared_region_name[i]);
1865 if (r->in_reserved_space()) {
1866 // This region was mapped inside a ReservedSpace. Its memory will be freed when the ReservedSpace
1867 // is released. Zero it so that we don't accidentally read its content.
1868 aot_log_info(aot)("Region #%d (%s) is in a reserved space, it will be freed when the space is released", i, shared_region_name[i]);
1869 } else {
1870 if (!os::unmap_memory(mapped_base, size)) {
1871 fatal("os::unmap_memory failed");
1872 }
1873 }
1874 }
1875 r->set_mapped_base(nullptr);
1876 }
1877 }
1878
1879 void FileMapInfo::assert_mark(bool check) {
1880 if (!check) {
1881 MetaspaceShared::unrecoverable_loading_error("Mark mismatch while restoring from shared file.");
1882 }
1883 }
1884
1885 FileMapInfo* FileMapInfo::_current_info = nullptr;
1886 FileMapInfo* FileMapInfo::_dynamic_archive_info = nullptr;
1887 bool FileMapInfo::_heap_pointers_need_patching = false;
1888 bool FileMapInfo::_memory_mapping_failed = false;
1889
1890 // Open the shared archive file, read and validate the header
1891 // information (version, boot classpath, etc.). If initialization
1892 // fails, shared spaces are disabled and the file is closed.
1893 //
1894 // Validation of the archive is done in two steps:
1895 //
1896 // [1] validate_header() - done here.
1897 // [2] validate_shared_path_table - this is done later, because the table is in the RO
1898 // region of the archive, which is not mapped yet.
1899 bool FileMapInfo::open_as_input() {
1900 assert(CDSConfig::is_using_archive(), "UseSharedSpaces expected.");
1901 assert(Arguments::has_jimage(), "The shared archive file cannot be used with an exploded module build.");
1902
1903 if (JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()) {
1904 // CDS assumes that no classes resolved in vmClasses::resolve_all()
1905 // are replaced at runtime by JVMTI ClassFileLoadHook. All of those classes are resolved
1906 // during the JVMTI "early" stage, so we can still use CDS if
1907 // JvmtiExport::has_early_class_hook_env() is false.
1908 MetaspaceShared::report_loading_error("CDS is disabled because early JVMTI ClassFileLoadHook is in use.");
1909 return false;
1910 }
1911
1912 if (!open_for_read() || !init_from_file(_fd) || !validate_header()) {
1913 if (_is_static) {
1914 MetaspaceShared::report_loading_error("Loading static archive failed.");
1915 return false;
1916 } else {
1917 MetaspaceShared::report_loading_error("Loading dynamic archive failed.");
1918 if (AutoCreateSharedArchive) {
1919 CDSConfig::enable_dumping_dynamic_archive(_full_path);
1920 }
1921 return false;
1922 }
1923 }
1924
1925 return true;
1926 }
1927
1928 bool FileMapInfo::validate_aot_class_linking() {
1929 // These checks need to be done after FileMapInfo::initialize(), which gets called before Universe::heap()
1930 // is available.
1931 if (header()->has_aot_linked_classes()) {
1932 const char* archive_type = CDSConfig::type_of_archive_being_loaded();
1933 CDSConfig::set_has_aot_linked_classes(true);
1934 if (JvmtiExport::should_post_class_file_load_hook()) {
1935 aot_log_error(aot)("%s has aot-linked classes. It cannot be used when JVMTI ClassFileLoadHook is in use.",
1936 archive_type);
1937 return false;
1938 }
1939 if (JvmtiExport::has_early_vmstart_env()) {
1940 aot_log_error(aot)("%s has aot-linked classes. It cannot be used when JVMTI early vm start is in use.",
1941 archive_type);
1942 return false;
1943 }
1944 if (!CDSConfig::is_using_full_module_graph()) {
1945 aot_log_error(aot)("%s has aot-linked classes. It cannot be used when archived full module graph is not used.",
1946 archive_type);
1947 return false;
1948 }
1949
1950 const char* prop = Arguments::get_property("java.security.manager");
1951 if (prop != nullptr && strcmp(prop, "disallow") != 0) {
1952 aot_log_error(aot)("%s has aot-linked classes. It cannot be used with -Djava.security.manager=%s.",
1953 archive_type, prop);
1954 return false;
1955 }
1956
1957 #if INCLUDE_JVMTI
1958 if (Arguments::has_jdwp_agent()) {
1959 aot_log_error(aot)("%s has aot-linked classes. It cannot be used with JDWP agent", archive_type);
1960 return false;
1961 }
1962 #endif
1963 }
1964
1965 return true;
1966 }
1967
1968 // The 2 core spaces are RW->RO
1969 FileMapRegion* FileMapInfo::first_core_region() const {
1970 return region_at(MetaspaceShared::rw);
1971 }
1972
1973 FileMapRegion* FileMapInfo::last_core_region() const {
1974 return region_at(MetaspaceShared::ro);
1975 }
1976
1977 void FileMapInfo::print(outputStream* st) const {
1978 header()->print(st);
1979 if (!is_static()) {
1980 dynamic_header()->print(st);
1981 }
1982 }
1983
1984 void FileMapHeader::set_as_offset(char* p, size_t *offset) {
1985 *offset = ArchiveBuilder::current()->any_to_offset((address)p);
1986 }
1987
1988 int FileMapHeader::compute_crc() {
1989 char* start = (char*)this;
1990 // start computing from the field after _header_size to end of base archive name.
1991 char* buf = (char*)&(_generic_header._header_size) + sizeof(_generic_header._header_size);
1992 size_t sz = header_size() - (buf - start);
1993 int crc = ClassLoader::crc32(0, buf, (jint)sz);
1994 return crc;
1995 }
1996
1997 // This function should only be called during run time with UseSharedSpaces enabled.
1998 bool FileMapHeader::validate() {
1999 const char* file_type = CDSConfig::type_of_archive_being_loaded();
2000 if (_obj_alignment != ObjectAlignmentInBytes) {
2001 MetaspaceShared::report_loading_error("The %s's ObjectAlignmentInBytes of %d"
2002 " does not equal the current ObjectAlignmentInBytes of %d.",
2003 file_type, _obj_alignment, ObjectAlignmentInBytes);
2004 return false;
2005 }
2006 if (_compact_strings != CompactStrings) {
2007 MetaspaceShared::report_loading_error("The %s's CompactStrings setting (%s)"
2008 " does not equal the current CompactStrings setting (%s).", file_type,
2009 _compact_strings ? "enabled" : "disabled",
2010 CompactStrings ? "enabled" : "disabled");
2011 return false;
2012 }
2013 bool jvmci_compiler_is_enabled = CompilerConfig::is_jvmci_compiler_enabled();
2014 CompilerType compiler_type = CompilerConfig::compiler_type();
2015 CompilerType archive_compiler_type = CompilerType(_compiler_type);
2016 // JVMCI compiler does different type profiling settigns and generate
2017 // different code. We can't use archive which was produced
2018 // without it and reverse.
2019 // Only allow mix when JIT compilation is disabled.
2020 // Interpreter is used by default when dumping archive.
2021 bool intepreter_is_used = (archive_compiler_type == CompilerType::compiler_none) ||
2022 (compiler_type == CompilerType::compiler_none);
2023 if (!intepreter_is_used &&
2024 jvmci_compiler_is_enabled != (archive_compiler_type == CompilerType::compiler_jvmci)) {
2025 MetaspaceShared::report_loading_error("The %s's JIT compiler setting (%s)"
2026 " does not equal the current setting (%s).", file_type,
2027 compilertype2name(archive_compiler_type), compilertype2name(compiler_type));
2028 return false;
2029 }
2030 if (TrainingData::have_data()) {
2031 if (_type_profile_level != TypeProfileLevel) {
2032 MetaspaceShared::report_loading_error("The %s's TypeProfileLevel setting (%d)"
2033 " does not equal the current TypeProfileLevel setting (%d).", file_type,
2034 _type_profile_level, TypeProfileLevel);
2035 return false;
2036 }
2037 if (_type_profile_args_limit != TypeProfileArgsLimit) {
2038 MetaspaceShared::report_loading_error("The %s's TypeProfileArgsLimit setting (%d)"
2039 " does not equal the current TypeProfileArgsLimit setting (%d).", file_type,
2040 _type_profile_args_limit, TypeProfileArgsLimit);
2041 return false;
2042 }
2043 if (_type_profile_parms_limit != TypeProfileParmsLimit) {
2044 MetaspaceShared::report_loading_error("The %s's TypeProfileParamsLimit setting (%d)"
2045 " does not equal the current TypeProfileParamsLimit setting (%d).", file_type,
2046 _type_profile_args_limit, TypeProfileArgsLimit);
2047 return false;
2048
2049 }
2050 if (_type_profile_width != TypeProfileWidth) {
2051 MetaspaceShared::report_loading_error("The %s's TypeProfileWidth setting (%d)"
2052 " does not equal the current TypeProfileWidth setting (%d).", file_type,
2053 (int)_type_profile_width, (int)TypeProfileWidth);
2054 return false;
2055
2056 }
2057 if (_bci_profile_width != BciProfileWidth) {
2058 MetaspaceShared::report_loading_error("The %s's BciProfileWidth setting (%d)"
2059 " does not equal the current BciProfileWidth setting (%d).", file_type,
2060 (int)_bci_profile_width, (int)BciProfileWidth);
2061 return false;
2062 }
2063 if (_type_profile_casts != TypeProfileCasts) {
2064 MetaspaceShared::report_loading_error("The %s's TypeProfileCasts setting (%s)"
2065 " does not equal the current TypeProfileCasts setting (%s).", file_type,
2066 _type_profile_casts ? "enabled" : "disabled",
2067 TypeProfileCasts ? "enabled" : "disabled");
2068
2069 return false;
2070
2071 }
2072 if (_profile_traps != ProfileTraps) {
2073 MetaspaceShared::report_loading_error("The %s's ProfileTraps setting (%s)"
2074 " does not equal the current ProfileTraps setting (%s).", file_type,
2075 _profile_traps ? "enabled" : "disabled",
2076 ProfileTraps ? "enabled" : "disabled");
2077
2078 return false;
2079 }
2080 if (_spec_trap_limit_extra_entries != SpecTrapLimitExtraEntries) {
2081 MetaspaceShared::report_loading_error("The %s's SpecTrapLimitExtraEntries setting (%d)"
2082 " does not equal the current SpecTrapLimitExtraEntries setting (%d).", file_type,
2083 _spec_trap_limit_extra_entries, SpecTrapLimitExtraEntries);
2084 return false;
2085
2086 }
2087 }
2088
2089 // This must be done after header validation because it might change the
2090 // header data
2091 const char* prop = Arguments::get_property("java.system.class.loader");
2092 if (prop != nullptr) {
2093 if (has_aot_linked_classes()) {
2094 MetaspaceShared::report_loading_error("%s has aot-linked classes. It cannot be used when the "
2095 "java.system.class.loader property is specified.",
2096 CDSConfig::type_of_archive_being_loaded());
2097 return false;
2098 }
2099 aot_log_warning(aot)("Archived non-system classes are disabled because the "
2100 "java.system.class.loader property is specified (value = \"%s\"). "
2101 "To use archived non-system classes, this property must not be set", prop);
2102 _has_platform_or_app_classes = false;
2103 }
2104
2105
2106 if (!_verify_local && BytecodeVerificationLocal) {
2107 // we cannot load boot classes, so there's no point of using the CDS archive
2108 MetaspaceShared::report_loading_error("The %s's BytecodeVerificationLocal setting (%s)"
2109 " does not equal the current BytecodeVerificationLocal setting (%s).", file_type,
2110 _verify_local ? "enabled" : "disabled",
2111 BytecodeVerificationLocal ? "enabled" : "disabled");
2112 return false;
2113 }
2114
2115 // For backwards compatibility, we don't check the BytecodeVerificationRemote setting
2116 // if the archive only contains system classes.
2117 if (_has_platform_or_app_classes
2118 && !_verify_remote // we didn't verify the archived platform/app classes
2119 && BytecodeVerificationRemote) { // but we want to verify all loaded platform/app classes
2120 aot_log_info(aot)("The %s was created with less restrictive "
2121 "verification setting than the current setting.", file_type);
2122 // Pretend that we didn't have any archived platform/app classes, so they won't be loaded
2123 // by SystemDictionaryShared.
2124 _has_platform_or_app_classes = false;
2125 }
2126
2127 // Java agents are allowed during run time. Therefore, the following condition is not
2128 // checked: (!_allow_archiving_with_java_agent && AllowArchivingWithJavaAgent)
2129 // Note: _allow_archiving_with_java_agent is set in the shared archive during dump time
2130 // while AllowArchivingWithJavaAgent is set during the current run.
2131 if (_allow_archiving_with_java_agent && !AllowArchivingWithJavaAgent) {
2132 MetaspaceShared::report_loading_error("The setting of the AllowArchivingWithJavaAgent is different "
2133 "from the setting in the %s.", file_type);
2134 return false;
2135 }
2136
2137 if (_allow_archiving_with_java_agent) {
2138 aot_log_warning(aot)("This %s was created with AllowArchivingWithJavaAgent. It should be used "
2139 "for testing purposes only and should not be used in a production environment", file_type);
2140 }
2141
2142 aot_log_info(aot)("The %s was created with UseCompressedOops = %d, UseCompressedClassPointers = %d, UseCompactObjectHeaders = %d",
2143 file_type, compressed_oops(), compressed_class_pointers(), compact_headers());
2144 if (compressed_oops() != UseCompressedOops || compressed_class_pointers() != UseCompressedClassPointers) {
2145 aot_log_warning(aot)("Unable to use %s.\nThe saved state of UseCompressedOops and UseCompressedClassPointers is "
2146 "different from runtime, CDS will be disabled.", file_type);
2147 return false;
2148 }
2149
2150 if (is_static()) {
2151 const char* err = nullptr;
2152 if (CDSConfig::is_valhalla_preview()) {
2153 if (!_has_valhalla_patched_classes) {
2154 err = "not created";
2155 }
2156 } else {
2157 if (_has_valhalla_patched_classes) {
2158 err = "created";
2159 }
2160 }
2161 if (err != nullptr) {
2162 log_warning(cds)("This archive was %s with --enable-preview -XX:+EnableValhalla. It is "
2163 "incompatible with the current JVM setting", err);
2164 return false;
2165 }
2166 }
2167
2168 if (compact_headers() != UseCompactObjectHeaders) {
2169 aot_log_warning(aot)("Unable to use %s.\nThe %s's UseCompactObjectHeaders setting (%s)"
2170 " does not equal the current UseCompactObjectHeaders setting (%s).", file_type, file_type,
2171 _compact_headers ? "enabled" : "disabled",
2172 UseCompactObjectHeaders ? "enabled" : "disabled");
2173 return false;
2174 }
2175
2176 if (!_use_optimized_module_handling && !CDSConfig::is_dumping_final_static_archive()) {
2177 CDSConfig::stop_using_optimized_module_handling();
2178 aot_log_info(aot)("optimized module handling: disabled because archive was created without optimized module handling");
2179 }
2180
2181 if (is_static()) {
2182 // Only the static archive can contain the full module graph.
2183 if (!_has_full_module_graph) {
2184 CDSConfig::stop_using_full_module_graph("archive was created without full module graph");
2185 }
2186 }
2187
2188 return true;
2189 }
2190
2191 bool FileMapInfo::validate_header() {
2192 if (!header()->validate()) {
2193 return false;
2194 }
2195 if (_is_static) {
2196 return true;
2197 } else {
2198 return DynamicArchive::validate(this);
2199 }
2200 }
2201
2202 #if INCLUDE_JVMTI
2203 ClassPathEntry** FileMapInfo::_classpath_entries_for_jvmti = nullptr;
2204
2205 ClassPathEntry* FileMapInfo::get_classpath_entry_for_jvmti(int i, TRAPS) {
2206 if (i == 0) {
2207 // index 0 corresponds to the ClassPathImageEntry which is a globally shared object
2208 // and should never be deleted.
2209 return ClassLoader::get_jrt_entry();
2210 }
2211 ClassPathEntry* ent = _classpath_entries_for_jvmti[i];
2212 if (ent == nullptr) {
2213 const AOTClassLocation* cl = AOTClassLocationConfig::runtime()->class_location_at(i);
2214 const char* path = cl->path();
2215 struct stat st;
2216 if (os::stat(path, &st) != 0) {
2217 char *msg = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, strlen(path) + 128);
2218 jio_snprintf(msg, strlen(path) + 127, "error in finding JAR file %s", path);
2219 THROW_MSG_(vmSymbols::java_io_IOException(), msg, nullptr);
2220 } else {
2221 ent = ClassLoader::create_class_path_entry(THREAD, path, &st);
2222 if (ent == nullptr) {
2223 char *msg = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, strlen(path) + 128);
2224 jio_snprintf(msg, strlen(path) + 127, "error in opening JAR file %s", path);
2225 THROW_MSG_(vmSymbols::java_io_IOException(), msg, nullptr);
2226 }
2227 }
2228
2229 MutexLocker mu(THREAD, CDSClassFileStream_lock);
2230 if (_classpath_entries_for_jvmti[i] == nullptr) {
2231 _classpath_entries_for_jvmti[i] = ent;
2232 } else {
2233 // Another thread has beat me to creating this entry
2234 delete ent;
2235 ent = _classpath_entries_for_jvmti[i];
2236 }
2237 }
2238
2239 return ent;
2240 }
2241
2242 ClassFileStream* FileMapInfo::open_stream_for_jvmti(InstanceKlass* ik, Handle class_loader, TRAPS) {
2243 int path_index = ik->shared_classpath_index();
2244 assert(path_index >= 0, "should be called for shared built-in classes only");
2245 assert(path_index < AOTClassLocationConfig::runtime()->length(), "sanity");
2246
2247 ClassPathEntry* cpe = get_classpath_entry_for_jvmti(path_index, CHECK_NULL);
2248 assert(cpe != nullptr, "must be");
2249
2250 Symbol* name = ik->name();
2251 const char* const class_name = name->as_C_string();
2252 const char* const file_name = ClassLoader::file_name_for_class_name(class_name,
2253 name->utf8_length());
2254 ClassLoaderData* loader_data = ClassLoaderData::class_loader_data(class_loader());
2255 const AOTClassLocation* cl = AOTClassLocationConfig::runtime()->class_location_at(path_index);
2256 ClassFileStream* cfs;
2257 if (class_loader() != nullptr && cl->is_multi_release_jar()) {
2258 // This class was loaded from a multi-release JAR file during dump time. The
2259 // process for finding its classfile is complex. Let's defer to the Java code
2260 // in java.lang.ClassLoader.
2261 cfs = get_stream_from_class_loader(class_loader, cpe, file_name, CHECK_NULL);
2262 } else {
2263 cfs = cpe->open_stream_for_loader(THREAD, file_name, loader_data);
2264 }
2265 assert(cfs != nullptr, "must be able to read the classfile data of shared classes for built-in loaders.");
2266 log_debug(aot, jvmti)("classfile data for %s [%d: %s] = %d bytes", class_name, path_index,
2267 cfs->source(), cfs->length());
2268 return cfs;
2269 }
2270
2271 ClassFileStream* FileMapInfo::get_stream_from_class_loader(Handle class_loader,
2272 ClassPathEntry* cpe,
2273 const char* file_name,
2274 TRAPS) {
2275 JavaValue result(T_OBJECT);
2276 oop class_name = java_lang_String::create_oop_from_str(file_name, THREAD);
2277 Handle h_class_name = Handle(THREAD, class_name);
2278
2279 // byte[] ClassLoader.getResourceAsByteArray(String name)
2280 JavaCalls::call_virtual(&result,
2281 class_loader,
2282 vmClasses::ClassLoader_klass(),
2283 vmSymbols::getResourceAsByteArray_name(),
2284 vmSymbols::getResourceAsByteArray_signature(),
2285 h_class_name,
2286 CHECK_NULL);
2287 assert(result.get_type() == T_OBJECT, "just checking");
2288 oop obj = result.get_oop();
2289 assert(obj != nullptr, "ClassLoader.getResourceAsByteArray should not return null");
2290
2291 // copy from byte[] to a buffer
2292 typeArrayOop ba = typeArrayOop(obj);
2293 jint len = ba->length();
2294 u1* buffer = NEW_RESOURCE_ARRAY(u1, len);
2295 ArrayAccess<>::arraycopy_to_native<>(ba, typeArrayOopDesc::element_offset<jbyte>(0), buffer, len);
2296
2297 return new ClassFileStream(buffer, len, cpe->name());
2298 }
2299 #endif