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