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