1 /*
2 * Copyright (c) 2003, 2026, 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/aotMappedHeapLoader.hpp"
28 #include "cds/aotMappedHeapWriter.hpp"
29 #include "cds/aotMetaspace.hpp"
30 #include "cds/archiveBuilder.hpp"
31 #include "cds/archiveUtils.inline.hpp"
32 #include "cds/cds_globals.hpp"
33 #include "cds/cdsConfig.hpp"
34 #include "cds/dynamicArchive.hpp"
35 #include "cds/filemap.hpp"
36 #include "cds/heapShared.inline.hpp"
37 #include "classfile/altHashing.hpp"
38 #include "classfile/classFileStream.hpp"
39 #include "classfile/classLoader.hpp"
40 #include "classfile/classLoader.inline.hpp"
41 #include "classfile/classLoaderData.inline.hpp"
42 #include "classfile/symbolTable.hpp"
43 #include "classfile/systemDictionaryShared.hpp"
44 #include "classfile/vmClasses.hpp"
45 #include "classfile/vmSymbols.hpp"
46 #include "compiler/compilerDefinitions.inline.hpp"
47 #include "jvm.h"
48 #include "logging/log.hpp"
49 #include "logging/logMessage.hpp"
50 #include "logging/logStream.hpp"
51 #include "memory/iterator.inline.hpp"
52 #include "memory/metadataFactory.hpp"
53 #include "memory/metaspaceClosure.hpp"
54 #include "memory/oopFactory.hpp"
55 #include "memory/universe.hpp"
56 #include "nmt/memTracker.hpp"
57 #include "oops/access.hpp"
58 #include "oops/compressedKlass.hpp"
59 #include "oops/compressedOops.hpp"
60 #include "oops/compressedOops.inline.hpp"
61 #include "oops/objArrayOop.hpp"
62 #include "oops/oop.inline.hpp"
63 #include "oops/trainingData.hpp"
64 #include "oops/typeArrayKlass.hpp"
65 #include "prims/jvmtiExport.hpp"
66 #include "runtime/arguments.hpp"
67 #include "runtime/globals_extension.hpp"
68 #include "runtime/java.hpp"
69 #include "runtime/javaCalls.hpp"
70 #include "runtime/mutexLocker.hpp"
71 #include "runtime/os.hpp"
72 #include "runtime/vm_version.hpp"
73 #include "utilities/align.hpp"
74 #include "utilities/bitMap.inline.hpp"
75 #include "utilities/classpathStream.hpp"
76 #include "utilities/defaultStream.hpp"
77 #include "utilities/ostream.hpp"
78 #if INCLUDE_G1GC
79 #include "gc/g1/g1CollectedHeap.hpp"
80 #include "gc/g1/g1HeapRegion.hpp"
81 #endif
82
83 #include <errno.h>
84 #include <sys/stat.h>
85
86 #ifndef O_BINARY // if defined (Win32) use binary files.
87 #define O_BINARY 0 // otherwise do nothing.
88 #endif
89
90 // 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 }
121
122 assert(header_version[JVM_IDENT_MAX-1] == 0, "must be");
123 }
124
125 FileMapInfo::FileMapInfo(const char* full_path, bool is_static) :
126 _is_static(is_static), _file_open(false), _is_mapped(false), _fd(-1), _file_offset(0),
127 _full_path(full_path), _base_archive_name(nullptr), _header(nullptr) {
128 if (_is_static) {
129 assert(_current_info == nullptr, "must be singleton"); // not thread safe
130 _current_info = this;
131 } else {
132 assert(_dynamic_archive_info == nullptr, "must be singleton"); // not thread safe
133 _dynamic_archive_info = this;
134 }
135 }
136
137 FileMapInfo::~FileMapInfo() {
138 if (_is_static) {
139 assert(_current_info == this, "must be singleton"); // not thread safe
140 _current_info = nullptr;
141 } else {
142 assert(_dynamic_archive_info == this, "must be singleton"); // not thread safe
143 _dynamic_archive_info = nullptr;
144 }
145
146 if (_header != nullptr) {
147 os::free(_header);
148 }
149
150 if (_file_open) {
151 ::close(_fd);
152 }
153 }
154
155 void FileMapInfo::free_current_info() {
156 assert(CDSConfig::is_dumping_final_static_archive(), "only supported in this mode");
157 assert(_current_info != nullptr, "sanity");
158 delete _current_info;
159 assert(_current_info == nullptr, "sanity"); // Side effect expected from the above "delete" operator.
160 }
161
162 void FileMapInfo::populate_header(size_t core_region_alignment) {
163 assert(_header == nullptr, "Sanity check");
164 size_t c_header_size;
165 size_t header_size;
166 size_t base_archive_name_size = 0;
167 size_t base_archive_name_offset = 0;
168 if (is_static()) {
169 c_header_size = sizeof(FileMapHeader);
170 header_size = c_header_size;
171 } else {
172 // dynamic header including base archive name for non-default base archive
173 c_header_size = sizeof(DynamicArchiveHeader);
174 header_size = c_header_size;
175
176 const char* default_base_archive_name = CDSConfig::default_archive_path();
177 const char* current_base_archive_name = CDSConfig::input_static_archive_path();
178 if (!os::same_files(current_base_archive_name, default_base_archive_name)) {
179 base_archive_name_size = strlen(current_base_archive_name) + 1;
180 header_size += base_archive_name_size;
181 base_archive_name_offset = c_header_size;
182 }
183 }
184 _header = (FileMapHeader*)os::malloc(header_size, mtInternal);
185 memset((void*)_header, 0, header_size);
186 _header->populate(this,
187 core_region_alignment,
188 header_size,
189 base_archive_name_size,
190 base_archive_name_offset);
191 }
192
193 void FileMapHeader::populate(FileMapInfo *info, size_t core_region_alignment,
194 size_t header_size, size_t base_archive_name_size,
195 size_t base_archive_name_offset) {
196 // 1. We require _generic_header._magic to be at the beginning of the file
197 // 2. FileMapHeader also assumes that _generic_header is at the beginning of the file
198 assert(offset_of(FileMapHeader, _generic_header) == 0, "must be");
199 set_header_size((unsigned int)header_size);
200 set_base_archive_name_offset((unsigned int)base_archive_name_offset);
201 set_base_archive_name_size((unsigned int)base_archive_name_size);
202 if (CDSConfig::is_dumping_dynamic_archive()) {
203 set_magic(CDS_DYNAMIC_ARCHIVE_MAGIC);
204 } else if (CDSConfig::is_dumping_preimage_static_archive()) {
205 set_magic(CDS_PREIMAGE_ARCHIVE_MAGIC);
206 } else {
207 set_magic(CDS_ARCHIVE_MAGIC);
208 }
209 set_version(CURRENT_CDS_ARCHIVE_VERSION);
210
211 if (!info->is_static() && base_archive_name_size != 0) {
212 // copy base archive name
213 copy_base_archive_name(CDSConfig::input_static_archive_path());
214 }
215 _core_region_alignment = core_region_alignment;
216 _obj_alignment = ObjectAlignmentInBytes;
217 _compact_strings = CompactStrings;
218 _compact_headers = UseCompactObjectHeaders;
219 #if INCLUDE_CDS_JAVA_HEAP
220 if (CDSConfig::is_dumping_heap()) {
221 _object_streaming_mode = HeapShared::is_writing_streaming_mode();
222 _narrow_oop_mode = AOTMappedHeapWriter::narrow_oop_mode();
223 _narrow_oop_base = AOTMappedHeapWriter::narrow_oop_base();
224 _narrow_oop_shift = AOTMappedHeapWriter::narrow_oop_shift();
225 }
226 #endif
227 _compressed_oops = UseCompressedOops;
228 _compatible_oop_compression = AOTCompatibleOopCompression;
229 _narrow_klass_pointer_bits = CompressedKlassPointers::narrow_klass_pointer_bits();
230 _narrow_klass_shift = ArchiveBuilder::precomputed_narrow_klass_shift();
231
232 // Which JIT compier is used
233 _compiler_type = (u1)CompilerConfig::compiler_type();
234 _type_profile_level = TypeProfileLevel;
235 _type_profile_args_limit = TypeProfileArgsLimit;
236 _type_profile_parms_limit = TypeProfileParmsLimit;
237 _type_profile_width = TypeProfileWidth;
238 _bci_profile_width = BciProfileWidth;
239 _profile_traps = ProfileTraps;
240 _type_profile_casts = TypeProfileCasts;
241 _spec_trap_limit_extra_entries = SpecTrapLimitExtraEntries;
242 _max_heap_size = MaxHeapSize;
243 _use_optimized_module_handling = CDSConfig::is_using_optimized_module_handling();
244 _has_aot_linked_classes = CDSConfig::is_dumping_aot_linked_classes();
245 _has_full_module_graph = CDSConfig::is_dumping_full_module_graph();
246
247 // The following fields are for sanity checks for whether this archive
248 // will function correctly with this JVM and the bootclasspath it's
249 // invoked with.
250
251 // JVM version string ... changes on each build.
252 get_header_version(_jvm_ident);
253
254 _verify_local = BytecodeVerificationLocal;
255 _verify_remote = BytecodeVerificationRemote;
256 _has_platform_or_app_classes = AOTClassLocationConfig::dumptime()->has_platform_or_app_classes();
257 _requested_base_address = (char*)SharedBaseAddress;
258 _mapped_base_address = (char*)SharedBaseAddress;
259 }
260
261 void FileMapHeader::copy_base_archive_name(const char* archive) {
262 assert(base_archive_name_size() != 0, "_base_archive_name_size not set");
263 assert(base_archive_name_offset() != 0, "_base_archive_name_offset not set");
264 assert(header_size() > sizeof(*this), "_base_archive_name_size not included in header size?");
265 memcpy((char*)this + base_archive_name_offset(), archive, base_archive_name_size());
266 }
267
268 void FileMapHeader::print(outputStream* st) {
269 ResourceMark rm;
270
271 st->print_cr("- magic: 0x%08x", magic());
272 st->print_cr("- crc: 0x%08x", crc());
273 st->print_cr("- version: 0x%x", version());
274 st->print_cr("- header_size: " UINT32_FORMAT, header_size());
275 st->print_cr("- base_archive_name_offset: " UINT32_FORMAT, base_archive_name_offset());
276 st->print_cr("- base_archive_name_size: " UINT32_FORMAT, base_archive_name_size());
277
278 for (int i = 0; i < NUM_CDS_REGIONS; i++) {
279 FileMapRegion* r = region_at(i);
280 r->print(st, i);
281 }
282 st->print_cr("============ end regions ======== ");
283
284 st->print_cr("- core_region_alignment: %zu", _core_region_alignment);
285 st->print_cr("- obj_alignment: %d", _obj_alignment);
286 st->print_cr("- narrow_oop_base: " INTPTR_FORMAT, p2i(_narrow_oop_base));
287 st->print_cr("- narrow_oop_shift %d", _narrow_oop_shift);
288 st->print_cr("- compact_strings: %d", _compact_strings);
289 st->print_cr("- compact_headers: %d", _compact_headers);
290 st->print_cr("- max_heap_size: %zu", _max_heap_size);
291 st->print_cr("- narrow_oop_mode: %d", _narrow_oop_mode);
292 st->print_cr("- compressed_oops: %d", _compressed_oops);
293 st->print_cr("- narrow_klass_pointer_bits: %d", _narrow_klass_pointer_bits);
294 st->print_cr("- narrow_klass_shift: %d", _narrow_klass_shift);
295 st->print_cr("- cloned_vtables: %u", cast_to_u4(_cloned_vtables));
296 st->print_cr("- early_serialized_data: %u", cast_to_u4(_early_serialized_data));
297 st->print_cr("- serialized_data: %u", cast_to_u4(_serialized_data));
298 st->print_cr("- jvm_ident: %s", _jvm_ident);
299 st->print_cr("- class_location_config: %d", cast_to_u4(_class_location_config));
300 st->print_cr("- verify_local: %d", _verify_local);
301 st->print_cr("- verify_remote: %d", _verify_remote);
302 st->print_cr("- has_platform_or_app_classes: %d", _has_platform_or_app_classes);
303 st->print_cr("- requested_base_address: " INTPTR_FORMAT, p2i(_requested_base_address));
304 st->print_cr("- mapped_base_address: " INTPTR_FORMAT, p2i(_mapped_base_address));
305
306 st->print_cr("- object_streaming_mode: %d", _object_streaming_mode);
307 st->print_cr("- mapped_heap_header");
308 st->print_cr(" - root_segments");
309 st->print_cr(" - roots_count: %d", _mapped_heap_header.root_segments().roots_count());
310 st->print_cr(" - base_offset: 0x%zx", _mapped_heap_header.root_segments().base_offset());
311 st->print_cr(" - count: %zu", _mapped_heap_header.root_segments().count());
312 st->print_cr(" - max_size_elems: %d", _mapped_heap_header.root_segments().max_size_in_elems());
313 st->print_cr(" - max_size_bytes: %zu", _mapped_heap_header.root_segments().max_size_in_bytes());
314 st->print_cr(" - oopmap_start_pos: %zu", _mapped_heap_header.oopmap_start_pos());
315 st->print_cr(" - oopmap_ptrmap_pos: %zu", _mapped_heap_header.ptrmap_start_pos());
316 st->print_cr("- streamed_heap_header");
317 st->print_cr(" - forwarding_offset: %zu", _streamed_heap_header.forwarding_offset());
318 st->print_cr(" - roots_offset: %zu", _streamed_heap_header.roots_offset());
319 st->print_cr(" - num_roots: %zu", _streamed_heap_header.num_roots());
320 st->print_cr(" - root_highest_object_index_table_offset: %zu", _streamed_heap_header.root_highest_object_index_table_offset());
321 st->print_cr(" - num_archived_objects: %zu", _streamed_heap_header.num_archived_objects());
322
323 st->print_cr("- _rw_ptrmap_start_pos: %zu", _rw_ptrmap_start_pos);
324 st->print_cr("- _ro_ptrmap_start_pos: %zu", _ro_ptrmap_start_pos);
325 st->print_cr("- use_optimized_module_handling: %d", _use_optimized_module_handling);
326 st->print_cr("- has_full_module_graph %d", _has_full_module_graph);
327 st->print_cr("- has_aot_linked_classes %d", _has_aot_linked_classes);
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(full_path(), header()->has_aot_linked_classes(), &has_extra_module_paths)) {
336 if (PrintSharedArchiveAndExit) {
337 AOTMetaspace::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 AOTMetaspace::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(_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 AOTMetaspace::report_loading_error("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 < AOTMetaspace::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, (jlong)pos, SEEK_SET) < 0) {
715 aot_log_error(aot)("Unable to seek to position %zu (errno=%d: %s)", pos, errno, os::strerror(errno));
716 AOTMetaspace::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 AOTMetaspace::writing_error();
772 return;
773 }
774 _fd = fd;
775 _file_open = true;
776 }
777
778 void FileMapInfo::prepare_for_writing() {
779 // Seek past the header. We will write the header after all regions are written
780 // and their CRCs computed.
781 size_t header_bytes = header()->header_size();
782
783 header_bytes = align_up(header_bytes, AOTMetaspace::core_region_alignment());
784 _file_offset = header_bytes;
785 seek_to_position(_file_offset);
786 }
787
788 // Write the header to the file, seek to the next allocation boundary.
789
790 void FileMapInfo::write_header() {
791 _file_offset = 0;
792 seek_to_position(_file_offset);
793 assert(is_file_position_aligned(), "must be");
794 write_bytes(header(), header()->header_size());
795 }
796
797 size_t FileMapRegion::used_aligned() const {
798 return align_up(used(), AOTMetaspace::core_region_alignment());
799 }
800
801 void FileMapRegion::init(int region_index, size_t mapping_offset, size_t size, bool read_only,
802 bool allow_exec, int crc) {
803 _is_heap_region = HeapShared::is_heap_region(region_index);
804 _is_bitmap_region = (region_index == AOTMetaspace::bm);
805 _mapping_offset = mapping_offset;
806 _used = size;
807 _read_only = read_only;
808 _allow_exec = allow_exec;
809 _crc = crc;
810 _mapped_from_file = false;
811 _mapped_base = nullptr;
812 _in_reserved_space = false;
813 }
814
815 void FileMapRegion::init_oopmap(size_t offset, size_t size_in_bits) {
816 _oopmap_offset = offset;
817 _oopmap_size_in_bits = size_in_bits;
818 }
819
820 void FileMapRegion::init_ptrmap(size_t offset, size_t size_in_bits) {
821 _ptrmap_offset = offset;
822 _ptrmap_size_in_bits = size_in_bits;
823 }
824
825 bool FileMapRegion::check_region_crc(char* base) const {
826 // This function should be called after the region has been properly
827 // loaded into memory via FileMapInfo::map_region() or FileMapInfo::read_region().
828 // I.e., this->mapped_base() must be valid.
829 size_t sz = used();
830 if (sz == 0) {
831 return true;
832 }
833
834 assert(base != nullptr, "must be initialized");
835 int crc = ClassLoader::crc32(0, base, (jint)sz);
836 if (crc != this->crc()) {
837 aot_log_warning(aot)("Checksum verification failed.");
838 return false;
839 }
840 return true;
841 }
842
843 static const char* region_name(int region_index) {
844 static const char* names[] = {
845 "rw", "ro", "bm", "hp", "ac"
846 };
847 const int num_regions = sizeof(names)/sizeof(names[0]);
848 assert(0 <= region_index && region_index < num_regions, "sanity");
849
850 return names[region_index];
851 }
852
853 BitMapView FileMapInfo::bitmap_view(int region_index, bool is_oopmap) {
854 FileMapRegion* r = region_at(region_index);
855 char* bitmap_base = is_static() ? FileMapInfo::current_info()->map_bitmap_region() : FileMapInfo::dynamic_info()->map_bitmap_region();
856 bitmap_base += is_oopmap ? r->oopmap_offset() : r->ptrmap_offset();
857 size_t size_in_bits = is_oopmap ? r->oopmap_size_in_bits() : r->ptrmap_size_in_bits();
858
859 aot_log_debug(aot, reloc)("mapped %s relocation %smap @ " INTPTR_FORMAT " (%zu bits)",
860 region_name(region_index), is_oopmap ? "oop" : "ptr",
861 p2i(bitmap_base), size_in_bits);
862
863 return BitMapView((BitMap::bm_word_t*)(bitmap_base), size_in_bits);
864 }
865
866 BitMapView FileMapInfo::oopmap_view(int region_index) {
867 return bitmap_view(region_index, /*is_oopmap*/true);
868 }
869
870 BitMapView FileMapInfo::ptrmap_view(int region_index) {
871 return bitmap_view(region_index, /*is_oopmap*/false);
872 }
873
874 void FileMapRegion::print(outputStream* st, int region_index) {
875 st->print_cr("============ region ============= %d \"%s\"", region_index, region_name(region_index));
876 st->print_cr("- crc: 0x%08x", _crc);
877 st->print_cr("- read_only: %d", _read_only);
878 st->print_cr("- allow_exec: %d", _allow_exec);
879 st->print_cr("- is_heap_region: %d", _is_heap_region);
880 st->print_cr("- is_bitmap_region: %d", _is_bitmap_region);
881 st->print_cr("- mapped_from_file: %d", _mapped_from_file);
882 st->print_cr("- file_offset: 0x%zx", _file_offset);
883 st->print_cr("- mapping_offset: 0x%zx", _mapping_offset);
884 st->print_cr("- used: %zu", _used);
885 st->print_cr("- oopmap_offset: 0x%zx", _oopmap_offset);
886 st->print_cr("- oopmap_size_in_bits: %zu", _oopmap_size_in_bits);
887 st->print_cr("- ptrmap_offset: 0x%zx", _ptrmap_offset);
888 st->print_cr("- ptrmap_size_in_bits: %zu", _ptrmap_size_in_bits);
889 st->print_cr("- mapped_base: " INTPTR_FORMAT, p2i(_mapped_base));
890 }
891
892 void FileMapInfo::write_region(int region, char* base, size_t size,
893 bool read_only, bool allow_exec) {
894 assert(CDSConfig::is_dumping_archive(), "sanity");
895
896 FileMapRegion* r = region_at(region);
897 char* requested_base;
898 size_t mapping_offset = 0;
899
900 if (region == AOTMetaspace::bm) {
901 requested_base = nullptr; // always null for bm region
902 } else if (size == 0) {
903 // This is an unused region (e.g., a heap region when !INCLUDE_CDS_JAVA_HEAP)
904 requested_base = nullptr;
905 } else if (HeapShared::is_heap_region(region)) {
906 assert(CDSConfig::is_dumping_heap(), "sanity");
907 #if INCLUDE_CDS_JAVA_HEAP
908 assert(!CDSConfig::is_dumping_dynamic_archive(), "must be");
909 if (HeapShared::is_writing_mapping_mode()) {
910 requested_base = (char*)AOTMappedHeapWriter::requested_address();
911 if (UseCompressedOops) {
912 mapping_offset = (size_t)((address)requested_base - AOTMappedHeapWriter::narrow_oop_base());
913 assert((mapping_offset >> CompressedOops::shift()) << CompressedOops::shift() == mapping_offset, "must be");
914 }
915 } else {
916 requested_base = nullptr;
917 }
918 #endif // INCLUDE_CDS_JAVA_HEAP
919 } else {
920 char* requested_SharedBaseAddress = (char*)AOTMetaspace::requested_base_address();
921 requested_base = ArchiveBuilder::current()->to_requested(base);
922 assert(requested_base >= requested_SharedBaseAddress, "must be");
923 mapping_offset = requested_base - requested_SharedBaseAddress;
924 }
925
926 r->set_file_offset(_file_offset);
927 int crc = ClassLoader::crc32(0, base, (jint)size);
928 if (size > 0) {
929 aot_log_info(aot)("Shared file region (%s) %d: %8zu"
930 " bytes, addr " INTPTR_FORMAT " file offset 0x%08" PRIxPTR
931 " crc 0x%08x",
932 region_name(region), region, size, p2i(requested_base), _file_offset, crc);
933 } else {
934 aot_log_info(aot)("Shared file region (%s) %d: %8zu"
935 " bytes", region_name(region), region, size);
936 }
937
938 r->init(region, mapping_offset, size, read_only, allow_exec, crc);
939
940 if (base != nullptr) {
941 write_bytes_aligned(base, size);
942 }
943 }
944
945 static size_t write_bitmap(const CHeapBitMap* map, char* output, size_t offset) {
946 size_t size_in_bytes = map->size_in_bytes();
947 map->write_to((BitMap::bm_word_t*)(output + offset), size_in_bytes);
948 return offset + size_in_bytes;
949 }
950
951 // The sorting code groups the objects with non-null oop/ptrs together.
952 // Relevant bitmaps then have lots of leading and trailing zeros, which
953 // we do not have to store.
954 size_t FileMapInfo::remove_bitmap_zeros(CHeapBitMap* map) {
955 BitMap::idx_t first_set = map->find_first_set_bit(0);
956 BitMap::idx_t last_set = map->find_last_set_bit(0);
957 size_t old_size = map->size();
958
959 // Slice and resize bitmap
960 map->truncate(first_set, last_set + 1);
961
962 assert(map->at(0), "First bit should be set");
963 assert(map->at(map->size() - 1), "Last bit should be set");
964 assert(map->size() <= old_size, "sanity");
965
966 return first_set;
967 }
968
969 char* FileMapInfo::write_bitmap_region(CHeapBitMap* rw_ptrmap,
970 CHeapBitMap* ro_ptrmap,
971 AOTMappedHeapInfo* mapped_heap_info,
972 AOTStreamedHeapInfo* streamed_heap_info,
973 size_t &size_in_bytes) {
974 size_t removed_rw_leading_zeros = remove_bitmap_zeros(rw_ptrmap);
975 size_t removed_ro_leading_zeros = remove_bitmap_zeros(ro_ptrmap);
976 header()->set_rw_ptrmap_start_pos(removed_rw_leading_zeros);
977 header()->set_ro_ptrmap_start_pos(removed_ro_leading_zeros);
978 size_in_bytes = rw_ptrmap->size_in_bytes() + ro_ptrmap->size_in_bytes();
979
980 if (mapped_heap_info != nullptr && mapped_heap_info->is_used()) {
981 // Remove leading and trailing zeros
982 assert(HeapShared::is_writing_mapping_mode(), "unexpected dumping mode");
983 size_t removed_oop_leading_zeros = remove_bitmap_zeros(mapped_heap_info->oopmap());
984 size_t removed_ptr_leading_zeros = remove_bitmap_zeros(mapped_heap_info->ptrmap());
985 mapped_heap_info->set_oopmap_start_pos(removed_oop_leading_zeros);
986 mapped_heap_info->set_ptrmap_start_pos(removed_ptr_leading_zeros);
987
988 size_in_bytes += mapped_heap_info->oopmap()->size_in_bytes();
989 size_in_bytes += mapped_heap_info->ptrmap()->size_in_bytes();
990 } else if (streamed_heap_info != nullptr && streamed_heap_info->is_used()) {
991 assert(HeapShared::is_writing_streaming_mode(), "unexpected dumping mode");
992
993 size_in_bytes += streamed_heap_info->oopmap()->size_in_bytes();
994 }
995
996 // The bitmap region contains up to 4 parts:
997 // rw_ptrmap: metaspace pointers inside the read-write region
998 // ro_ptrmap: metaspace pointers inside the read-only region
999 // *_heap_info->oopmap(): Java oop pointers in the heap region
1000 // mapped_heap_info->ptrmap(): metaspace pointers in the heap region
1001 char* buffer = NEW_C_HEAP_ARRAY(char, size_in_bytes, mtClassShared);
1002 size_t written = 0;
1003
1004 region_at(AOTMetaspace::rw)->init_ptrmap(0, rw_ptrmap->size());
1005 written = write_bitmap(rw_ptrmap, buffer, written);
1006
1007 region_at(AOTMetaspace::ro)->init_ptrmap(written, ro_ptrmap->size());
1008 written = write_bitmap(ro_ptrmap, buffer, written);
1009
1010 if (mapped_heap_info != nullptr && mapped_heap_info->is_used()) {
1011 assert(HeapShared::is_writing_mapping_mode(), "unexpected dumping mode");
1012 FileMapRegion* r = region_at(AOTMetaspace::hp);
1013
1014 r->init_oopmap(written, mapped_heap_info->oopmap()->size());
1015 written = write_bitmap(mapped_heap_info->oopmap(), buffer, written);
1016
1017 r->init_ptrmap(written, mapped_heap_info->ptrmap()->size());
1018 written = write_bitmap(mapped_heap_info->ptrmap(), buffer, written);
1019 } else if (streamed_heap_info != nullptr && streamed_heap_info->is_used()) {
1020 assert(HeapShared::is_writing_streaming_mode(), "unexpected dumping mode");
1021 FileMapRegion* r = region_at(AOTMetaspace::hp);
1022
1023 r->init_oopmap(written, streamed_heap_info->oopmap()->size());
1024 written = write_bitmap(streamed_heap_info->oopmap(), buffer, written);
1025 }
1026
1027 write_region(AOTMetaspace::bm, (char*)buffer, size_in_bytes, /*read_only=*/true, /*allow_exec=*/false);
1028 return buffer;
1029 }
1030
1031 #if INCLUDE_CDS_JAVA_HEAP
1032 size_t FileMapInfo::write_mapped_heap_region(AOTMappedHeapInfo* heap_info) {
1033 char* buffer_start = heap_info->buffer_start();
1034 size_t buffer_size = heap_info->buffer_byte_size();
1035 write_region(AOTMetaspace::hp, buffer_start, buffer_size, false, false);
1036 header()->set_mapped_heap_header(heap_info->create_header());
1037 return buffer_size;
1038 }
1039
1040 size_t FileMapInfo::write_streamed_heap_region(AOTStreamedHeapInfo* heap_info) {
1041 char* buffer_start = heap_info->buffer_start();
1042 size_t buffer_size = heap_info->buffer_byte_size();
1043 write_region(AOTMetaspace::hp, buffer_start, buffer_size, true, false);
1044 header()->set_streamed_heap_header(heap_info->create_header());
1045 return buffer_size;
1046 }
1047 #endif // INCLUDE_CDS_JAVA_HEAP
1048
1049 // Dump bytes to file -- at the current file position.
1050
1051 void FileMapInfo::write_bytes(const void* buffer, size_t nbytes) {
1052 assert(_file_open, "must be");
1053 if (!os::write(_fd, buffer, nbytes)) {
1054 // If the shared archive is corrupted, close it and remove it.
1055 close();
1056 remove(_full_path);
1057
1058 if (CDSConfig::is_dumping_preimage_static_archive()) {
1059 AOTMetaspace::writing_error("Unable to write to AOT configuration file.");
1060 } else if (CDSConfig::new_aot_flags_used()) {
1061 AOTMetaspace::writing_error("Unable to write to AOT cache.");
1062 } else {
1063 AOTMetaspace::writing_error("Unable to write to shared archive.");
1064 }
1065 }
1066 _file_offset += nbytes;
1067 }
1068
1069 bool FileMapInfo::is_file_position_aligned() const {
1070 return _file_offset == align_up(_file_offset,
1071 AOTMetaspace::core_region_alignment());
1072 }
1073
1074 // Align file position to an allocation unit boundary.
1075
1076 void FileMapInfo::align_file_position() {
1077 assert(_file_open, "must be");
1078 size_t new_file_offset = align_up(_file_offset,
1079 AOTMetaspace::core_region_alignment());
1080 if (new_file_offset != _file_offset) {
1081 _file_offset = new_file_offset;
1082 // Seek one byte back from the target and write a byte to insure
1083 // that the written file is the correct length.
1084 _file_offset -= 1;
1085 seek_to_position(_file_offset);
1086 char zero = 0;
1087 write_bytes(&zero, 1);
1088 }
1089 }
1090
1091
1092 // Dump bytes to file -- at the current file position.
1093
1094 void FileMapInfo::write_bytes_aligned(const void* buffer, size_t nbytes) {
1095 align_file_position();
1096 write_bytes(buffer, nbytes);
1097 align_file_position();
1098 }
1099
1100 // Close the shared archive file. This does NOT unmap mapped regions.
1101
1102 void FileMapInfo::close() {
1103 if (_file_open) {
1104 if (::close(_fd) < 0) {
1105 AOTMetaspace::unrecoverable_loading_error("Unable to close the shared archive file.");
1106 }
1107 _file_open = false;
1108 _fd = -1;
1109 }
1110 }
1111
1112 /*
1113 * Same as os::map_memory() but also pretouches if AlwaysPreTouch is enabled.
1114 */
1115 static char* map_memory(int fd, const char* file_name, size_t file_offset,
1116 char* addr, size_t bytes, bool read_only,
1117 bool allow_exec, MemTag mem_tag) {
1118 char* mem = os::map_memory(fd, file_name, file_offset, addr, bytes,
1119 mem_tag, AlwaysPreTouch ? false : read_only,
1120 allow_exec);
1121 if (mem != nullptr && AlwaysPreTouch) {
1122 os::pretouch_memory(mem, mem + bytes);
1123 }
1124 return mem;
1125 }
1126
1127 char* FileMapInfo::map_heap_region(FileMapRegion* r, char* addr, size_t bytes) {
1128 return ::map_memory(_fd,
1129 _full_path,
1130 r->file_offset(),
1131 addr,
1132 bytes,
1133 r->read_only(),
1134 r->allow_exec(),
1135 mtJavaHeap);
1136 }
1137
1138 // JVM/TI RedefineClasses() support:
1139 // Remap the shared readonly space to shared readwrite, private.
1140 bool FileMapInfo::remap_shared_readonly_as_readwrite() {
1141 int idx = AOTMetaspace::ro;
1142 FileMapRegion* r = region_at(idx);
1143 if (!r->read_only()) {
1144 // the space is already readwrite so we are done
1145 return true;
1146 }
1147 size_t size = r->used_aligned();
1148 if (!open_for_read()) {
1149 return false;
1150 }
1151 char *addr = r->mapped_base();
1152 // This path should not be reached for Windows; see JDK-8222379.
1153 assert(WINDOWS_ONLY(false) NOT_WINDOWS(true), "Don't call on Windows");
1154 // Replace old mapping with new one that is writable.
1155 char *base = os::map_memory(_fd, _full_path, r->file_offset(),
1156 addr, size, mtNone, false /* !read_only */,
1157 r->allow_exec());
1158 close();
1159 // These have to be errors because the shared region is now unmapped.
1160 if (base == nullptr) {
1161 aot_log_error(aot)("Unable to remap shared readonly space (errno=%d).", errno);
1162 vm_exit(1);
1163 }
1164 if (base != addr) {
1165 aot_log_error(aot)("Unable to remap shared readonly space (errno=%d).", errno);
1166 vm_exit(1);
1167 }
1168 r->set_read_only(false);
1169 return true;
1170 }
1171
1172 // Memory map a region in the address space.
1173 static const char* shared_region_name[] = { "ReadWrite", "ReadOnly", "Bitmap", "Heap", "Code" };
1174
1175 MapArchiveResult FileMapInfo::map_regions(int regions[], int num_regions, char* mapped_base_address, ReservedSpace rs) {
1176 DEBUG_ONLY(FileMapRegion* last_region = nullptr);
1177 intx addr_delta = mapped_base_address - header()->requested_base_address();
1178
1179 // Make sure we don't attempt to use header()->mapped_base_address() unless
1180 // it's been successfully mapped.
1181 DEBUG_ONLY(header()->set_mapped_base_address((char*)(uintptr_t)0xdeadbeef);)
1182
1183 for (int i = 0; i < num_regions; i++) {
1184 int idx = regions[i];
1185 MapArchiveResult result = map_region(idx, addr_delta, mapped_base_address, rs);
1186 if (result != MAP_ARCHIVE_SUCCESS) {
1187 return result;
1188 }
1189 FileMapRegion* r = region_at(idx);
1190 DEBUG_ONLY(if (last_region != nullptr) {
1191 // Ensure that the OS won't be able to allocate new memory spaces between any mapped
1192 // regions, or else it would mess up the simple comparison in MetaspaceObj::in_aot_cache().
1193 assert(r->mapped_base() == last_region->mapped_end(), "must have no gaps");
1194 }
1195 last_region = r;)
1196 aot_log_info(aot)("Mapped %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)", is_static() ? "static " : "dynamic",
1197 idx, p2i(r->mapped_base()), p2i(r->mapped_end()),
1198 shared_region_name[idx]);
1199
1200 }
1201
1202 header()->set_mapped_base_address(header()->requested_base_address() + addr_delta);
1203 if (addr_delta != 0 && !relocate_pointers_in_core_regions(addr_delta)) {
1204 return MAP_ARCHIVE_OTHER_FAILURE;
1205 }
1206
1207 return MAP_ARCHIVE_SUCCESS;
1208 }
1209
1210 bool FileMapInfo::read_region(int i, char* base, size_t size, bool do_commit) {
1211 FileMapRegion* r = region_at(i);
1212 if (do_commit) {
1213 aot_log_info(aot)("Commit %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)%s",
1214 is_static() ? "static " : "dynamic", i, p2i(base), p2i(base + size),
1215 shared_region_name[i], r->allow_exec() ? " exec" : "");
1216 if (!os::commit_memory(base, size, r->allow_exec())) {
1217 aot_log_error(aot)("Failed to commit %s region #%d (%s)", is_static() ? "static " : "dynamic",
1218 i, shared_region_name[i]);
1219 return false;
1220 }
1221 }
1222 if (os::lseek(_fd, (long)r->file_offset(), SEEK_SET) != (int)r->file_offset() ||
1223 read_bytes(base, size) != size) {
1224 return false;
1225 }
1226
1227 if (VerifySharedSpaces && !r->check_region_crc(base)) {
1228 return false;
1229 }
1230
1231 r->set_mapped_from_file(false);
1232 r->set_mapped_base(base);
1233
1234 return true;
1235 }
1236
1237 MapArchiveResult FileMapInfo::map_region(int i, intx addr_delta, char* mapped_base_address, ReservedSpace rs) {
1238 assert(!HeapShared::is_heap_region(i), "sanity");
1239 FileMapRegion* r = region_at(i);
1240 size_t size = r->used_aligned();
1241 char *requested_addr = mapped_base_address + r->mapping_offset();
1242 assert(!is_mapped(), "must be not mapped yet");
1243 assert(requested_addr != nullptr, "must be specified");
1244
1245 r->set_mapped_from_file(false);
1246 r->set_in_reserved_space(false);
1247
1248 if (AOTMetaspace::use_windows_memory_mapping()) {
1249 // Windows cannot remap read-only shared memory to read-write when required for
1250 // RedefineClasses, which is also used by JFR. Always map windows regions as RW.
1251 r->set_read_only(false);
1252 } else if (JvmtiExport::can_modify_any_class() || JvmtiExport::can_walk_any_space() ||
1253 Arguments::has_jfr_option()) {
1254 // If a tool agent is in use (debugging enabled), or JFR, we must map the address space RW
1255 r->set_read_only(false);
1256 } else if (addr_delta != 0) {
1257 r->set_read_only(false); // Need to patch the pointers
1258 }
1259
1260 if (AOTMetaspace::use_windows_memory_mapping() && rs.is_reserved()) {
1261 // This is the second time we try to map the archive(s). We have already created a ReservedSpace
1262 // that covers all the FileMapRegions to ensure all regions can be mapped. However, Windows
1263 // can't mmap into a ReservedSpace, so we just ::read() the data. We're going to patch all the
1264 // regions anyway, so there's no benefit for mmap anyway.
1265 if (!read_region(i, requested_addr, size, /* do_commit = */ true)) {
1266 AOTMetaspace::report_loading_error("Failed to read %s shared space into reserved space at " INTPTR_FORMAT,
1267 shared_region_name[i], p2i(requested_addr));
1268 return MAP_ARCHIVE_OTHER_FAILURE; // oom or I/O error.
1269 } else {
1270 assert(r->mapped_base() != nullptr, "must be initialized");
1271 }
1272 } else {
1273 // Note that this may either be a "fresh" mapping into unreserved address
1274 // space (Windows, first mapping attempt), or a mapping into pre-reserved
1275 // space (Posix). See also comment in AOTMetaspace::map_archives().
1276 char* base = map_memory(_fd, _full_path, r->file_offset(),
1277 requested_addr, size, r->read_only(),
1278 r->allow_exec(), mtClassShared);
1279 if (base != requested_addr) {
1280 AOTMetaspace::report_loading_error("Unable to map %s shared space at " INTPTR_FORMAT,
1281 shared_region_name[i], p2i(requested_addr));
1282 _memory_mapping_failed = true;
1283 return MAP_ARCHIVE_MMAP_FAILURE;
1284 }
1285
1286 if (VerifySharedSpaces && !r->check_region_crc(requested_addr)) {
1287 return MAP_ARCHIVE_OTHER_FAILURE;
1288 }
1289
1290 r->set_mapped_from_file(true);
1291 r->set_mapped_base(requested_addr);
1292 }
1293
1294 if (rs.is_reserved()) {
1295 char* mapped_base = r->mapped_base();
1296 assert(rs.base() <= mapped_base && mapped_base + size <= rs.end(),
1297 PTR_FORMAT " <= " PTR_FORMAT " < " PTR_FORMAT " <= " PTR_FORMAT,
1298 p2i(rs.base()), p2i(mapped_base), p2i(mapped_base + size), p2i(rs.end()));
1299 r->set_in_reserved_space(rs.is_reserved());
1300 }
1301 return MAP_ARCHIVE_SUCCESS;
1302 }
1303
1304 // The return value is the location of the archive relocation bitmap.
1305 char* FileMapInfo::map_auxiliary_region(int region_index, bool read_only) {
1306 FileMapRegion* r = region_at(region_index);
1307 if (r->mapped_base() != nullptr) {
1308 return r->mapped_base();
1309 }
1310 const char* region_name = shared_region_name[region_index];
1311 bool allow_exec = false;
1312 char* requested_addr = nullptr; // allow OS to pick any location
1313 char* mapped_base = map_memory(_fd, _full_path, r->file_offset(),
1314 requested_addr, r->used_aligned(), read_only, allow_exec, mtClassShared);
1315 if (mapped_base == nullptr) {
1316 AOTMetaspace::report_loading_error("failed to map %d region", region_index);
1317 return nullptr;
1318 }
1319
1320 if (VerifySharedSpaces && !r->check_region_crc(mapped_base)) {
1321 aot_log_error(aot)("region %d CRC error", region_index);
1322 os::unmap_memory(mapped_base, r->used_aligned());
1323 return nullptr;
1324 }
1325
1326 r->set_mapped_from_file(true);
1327 r->set_mapped_base(mapped_base);
1328 aot_log_info(aot)("Mapped %s region #%d at base %zu top %zu (%s)",
1329 is_static() ? "static " : "dynamic",
1330 region_index, p2i(r->mapped_base()), p2i(r->mapped_end()),
1331 region_name);
1332 return mapped_base;
1333 }
1334
1335 char* FileMapInfo::map_bitmap_region() {
1336 return map_auxiliary_region(AOTMetaspace::bm, false);
1337 }
1338
1339 bool FileMapInfo::map_aot_code_region(ReservedSpace rs) {
1340 FileMapRegion* r = region_at(AOTMetaspace::ac);
1341 assert(r->used() > 0 && r->used_aligned() == rs.size(), "must be");
1342
1343 if (UseCompressedOops) {
1344 precond(header()->compatible_oop_compression() == AOTCompatibleOopCompression);
1345 }
1346
1347 char* requested_base = rs.base();
1348 assert(requested_base != nullptr, "should be inside code cache");
1349
1350 char* mapped_base;
1351 if (AOTMetaspace::use_windows_memory_mapping()) {
1352 if (!read_region(AOTMetaspace::ac, requested_base, r->used_aligned(), /* do_commit = */ true)) {
1353 AOTMetaspace::report_loading_error("Failed to read aot code shared space into reserved space at " INTPTR_FORMAT,
1354 p2i(requested_base));
1355 return false;
1356 }
1357 mapped_base = requested_base;
1358 } else {
1359 // We do not execute in-place in the AOT code region.
1360 // AOT code is copied to the CodeCache for execution.
1361 bool read_only = false, allow_exec = false;
1362 mapped_base = map_memory(_fd, _full_path, r->file_offset(),
1363 requested_base, r->used_aligned(), read_only, allow_exec, mtClassShared);
1364 }
1365 if (mapped_base == nullptr) {
1366 AOTMetaspace::report_loading_error("failed to map aot code region");
1367 return false;
1368 } else {
1369 assert(mapped_base == requested_base, "must be");
1370
1371 if (VerifySharedSpaces && !r->check_region_crc(mapped_base)) {
1372 aot_log_error(aot)("region %d CRC error", AOTMetaspace::ac);
1373 os::unmap_memory(mapped_base, r->used_aligned());
1374 return false;
1375 }
1376
1377 r->set_mapped_from_file(true);
1378 r->set_mapped_base(mapped_base);
1379 aot_log_info(aot)("Mapped static region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)",
1380 AOTMetaspace::ac, p2i(r->mapped_base()), p2i(r->mapped_end()),
1381 shared_region_name[AOTMetaspace::ac]);
1382 return true;
1383 }
1384 }
1385
1386 class SharedDataRelocationTask : public ArchiveWorkerTask {
1387 private:
1388 BitMapView* const _rw_bm;
1389 BitMapView* const _ro_bm;
1390 SharedDataRelocator* const _rw_reloc;
1391 SharedDataRelocator* const _ro_reloc;
1392
1393 public:
1394 SharedDataRelocationTask(BitMapView* rw_bm, BitMapView* ro_bm, SharedDataRelocator* rw_reloc, SharedDataRelocator* ro_reloc) :
1395 ArchiveWorkerTask("Shared Data Relocation"),
1396 _rw_bm(rw_bm), _ro_bm(ro_bm), _rw_reloc(rw_reloc), _ro_reloc(ro_reloc) {}
1397
1398 void work(int chunk, int max_chunks) override {
1399 work_on(chunk, max_chunks, _rw_bm, _rw_reloc);
1400 work_on(chunk, max_chunks, _ro_bm, _ro_reloc);
1401 }
1402
1403 void work_on(int chunk, int max_chunks, BitMapView* bm, SharedDataRelocator* reloc) {
1404 BitMap::idx_t size = bm->size();
1405 BitMap::idx_t start = MIN2(size, size * chunk / max_chunks);
1406 BitMap::idx_t end = MIN2(size, size * (chunk + 1) / max_chunks);
1407 assert(end > start, "Sanity: no empty slices");
1408 bm->iterate(reloc, start, end);
1409 }
1410 };
1411
1412 // This is called when we cannot map the archive at the requested[ base address (usually 0x800000000).
1413 // We relocate all pointers in the 2 core regions (ro, rw).
1414 bool FileMapInfo::relocate_pointers_in_core_regions(intx addr_delta) {
1415 aot_log_debug(aot, reloc)("runtime archive relocation start");
1416 char* bitmap_base = map_bitmap_region();
1417
1418 if (bitmap_base == nullptr) {
1419 return false; // OOM, or CRC check failure
1420 } else {
1421 BitMapView rw_ptrmap = ptrmap_view(AOTMetaspace::rw);
1422 BitMapView ro_ptrmap = ptrmap_view(AOTMetaspace::ro);
1423
1424 FileMapRegion* rw_region = first_core_region();
1425 FileMapRegion* ro_region = last_core_region();
1426
1427 // Patch all pointers inside the RW region
1428 address rw_patch_base = (address)rw_region->mapped_base();
1429 address rw_patch_end = (address)rw_region->mapped_end();
1430
1431 // Patch all pointers inside the RO region
1432 address ro_patch_base = (address)ro_region->mapped_base();
1433 address ro_patch_end = (address)ro_region->mapped_end();
1434
1435 // the current value of the pointers to be patched must be within this
1436 // range (i.e., must be between the requested base address and the address of the current archive).
1437 // Note: top archive may point to objects in the base archive, but not the other way around.
1438 address valid_old_base = (address)header()->requested_base_address();
1439 address valid_old_end = valid_old_base + mapping_end_offset();
1440
1441 // after patching, the pointers must point inside this range
1442 // (the requested location of the archive, as mapped at runtime).
1443 address valid_new_base = (address)header()->mapped_base_address();
1444 address valid_new_end = (address)mapped_end();
1445
1446 SharedDataRelocator rw_patcher((address*)rw_patch_base + header()->rw_ptrmap_start_pos(), (address*)rw_patch_end, valid_old_base, valid_old_end,
1447 valid_new_base, valid_new_end, addr_delta);
1448 SharedDataRelocator ro_patcher((address*)ro_patch_base + header()->ro_ptrmap_start_pos(), (address*)ro_patch_end, valid_old_base, valid_old_end,
1449 valid_new_base, valid_new_end, addr_delta);
1450
1451 if (AOTCacheParallelRelocation) {
1452 ArchiveWorkers workers;
1453 SharedDataRelocationTask task(&rw_ptrmap, &ro_ptrmap, &rw_patcher, &ro_patcher);
1454 workers.run_task(&task);
1455 } else {
1456 rw_ptrmap.iterate(&rw_patcher);
1457 ro_ptrmap.iterate(&ro_patcher);
1458 }
1459
1460 // The AOTMetaspace::bm region will be unmapped in AOTMetaspace::initialize_shared_spaces().
1461
1462 aot_log_debug(aot, reloc)("runtime archive relocation done");
1463 return true;
1464 }
1465 }
1466
1467 size_t FileMapInfo::read_bytes(void* buffer, size_t count) {
1468 assert(_file_open, "Archive file is not open");
1469 size_t n = ::read(_fd, buffer, (unsigned int)count);
1470 if (n != count) {
1471 // Close the file if there's a problem reading it.
1472 close();
1473 return 0;
1474 }
1475 _file_offset += count;
1476 return count;
1477 }
1478
1479 // Get the total size in bytes of all mapped read only region
1480 size_t FileMapInfo::readonly_total() {
1481 size_t total = 0;
1482 if (current_info() != nullptr && current_info()->is_mapped()) {
1483 FileMapRegion* r = FileMapInfo::current_info()->region_at(AOTMetaspace::ro);
1484 if (r->read_only()) total += r->used();
1485 }
1486 if (dynamic_info() != nullptr && current_info()->is_mapped()) {
1487 FileMapRegion* r = FileMapInfo::dynamic_info()->region_at(AOTMetaspace::ro);
1488 if (r->read_only()) total += r->used();
1489 }
1490 return total;
1491 }
1492
1493 #if INCLUDE_CDS_JAVA_HEAP
1494
1495 bool FileMapInfo::has_heap_region() {
1496 return (region_at(AOTMetaspace::hp)->used() > 0);
1497 }
1498
1499 static void on_heap_region_loading_error() {
1500 if (CDSConfig::is_using_aot_linked_classes()) {
1501 // It's too late to recover -- we have already committed to use the archived metaspace objects, but
1502 // the archived heap objects cannot be loaded, so we don't have the archived FMG to guarantee that
1503 // all AOT-linked classes are visible.
1504 //
1505 // We get here because the heap is too small. The app will fail anyway. So let's quit.
1506 aot_log_error(aot)("%s has aot-linked classes but the archived "
1507 "heap objects cannot be loaded. Try increasing your heap size.",
1508 CDSConfig::type_of_archive_being_loaded());
1509 AOTMetaspace::unrecoverable_loading_error();
1510 }
1511 CDSConfig::stop_using_full_module_graph();
1512 }
1513
1514 void FileMapInfo::stream_heap_region() {
1515 assert(object_streaming_mode(), "This should only be done for the streaming approach");
1516
1517 if (map_auxiliary_region(AOTMetaspace::hp, /*readonly=*/true) != nullptr) {
1518 HeapShared::initialize_streaming();
1519 } else {
1520 on_heap_region_loading_error();
1521 }
1522 }
1523
1524 void FileMapInfo::map_or_load_heap_region() {
1525 assert(!object_streaming_mode(), "This should only be done for the mapping approach");
1526 bool success = false;
1527
1528 if (AOTMappedHeapLoader::can_map()) {
1529 success = AOTMappedHeapLoader::map_heap_region(this);
1530 } else if (AOTMappedHeapLoader::can_load()) {
1531 success = AOTMappedHeapLoader::load_heap_region(this);
1532 }
1533
1534 if (!success) {
1535 on_heap_region_loading_error();
1536 }
1537 }
1538
1539 bool FileMapInfo::can_use_heap_region() {
1540 if (!has_heap_region()) {
1541 return false;
1542 }
1543
1544 if (!object_streaming_mode() && !AOTMappedHeapLoader::can_use()) {
1545 // Currently this happens only when using ZGC with an AOT cache generated with -XX:-AOTStreamableObjects
1546 AOTMetaspace::report_loading_error("CDS heap data cannot be used by the selected GC. "
1547 "Please choose a different GC or rebuild AOT cache "
1548 "with -XX:+AOTStreamableObjects");
1549 return false;
1550 }
1551
1552 if (CDSConfig::is_using_aot_linked_classes()) {
1553 assert(!JvmtiExport::should_post_class_file_load_hook(), "already checked");
1554 assert(CDSConfig::is_using_full_module_graph(), "already checked");
1555 } else {
1556 if (JvmtiExport::should_post_class_file_load_hook()) {
1557 AOTMetaspace::report_loading_error("CDS heap data is disabled because JVMTI ClassFileLoadHook is in use.");
1558 return false;
1559 }
1560 if (!CDSConfig::is_using_full_module_graph()) {
1561 if (CDSConfig::is_dumping_final_static_archive()) {
1562 // We are loading the preimage static archive, which has no KlassSubGraphs.
1563 // See CDSConfig::is_dumping_klass_subgraphs()
1564 } else {
1565 AOTMetaspace::report_loading_error("CDS heap data is disabled because archived full module graph is not used.");
1566 return false;
1567 }
1568 }
1569 }
1570
1571 if (JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()) {
1572 ShouldNotReachHere(); // CDS should have been disabled.
1573 // The archived objects are mapped at JVM start-up, but we don't know if
1574 // j.l.String or j.l.Class might be replaced by the ClassFileLoadHook,
1575 // which would make the archived String or mirror objects invalid. Let's be safe and not
1576 // use the archived objects. These 2 classes are loaded during the JVMTI "early" stage.
1577 //
1578 // If JvmtiExport::has_early_class_hook_env() is false, the classes of some objects
1579 // in the archived subgraphs may be replaced by the ClassFileLoadHook. But that's OK
1580 // because we won't install an archived object subgraph if the klass of any of the
1581 // referenced objects are replaced. See HeapShared::initialize_from_archived_subgraph().
1582 }
1583
1584 // We pre-compute narrow Klass IDs with the runtime mapping start intended to be the base, and a shift of
1585 // HeapShared::precomputed_narrow_klass_shift. We enforce this encoding at runtime (see
1586 // CompressedKlassPointers::initialize_for_given_encoding()). Therefore, the following assertions must
1587 // hold:
1588 address archive_narrow_klass_base = (address)header()->mapped_base_address();
1589 const int archive_narrow_klass_pointer_bits = header()->narrow_klass_pointer_bits();
1590 const int archive_narrow_klass_shift = header()->narrow_klass_shift();
1591
1592 aot_log_info(aot)("CDS archive was created with max heap size = %zuM, and the following configuration:",
1593 max_heap_size()/M);
1594
1595 aot_log_info(aot)(" narrow_klass_base at mapping start address, narrow_klass_pointer_bits = %d, narrow_klass_shift = %d",
1596 archive_narrow_klass_pointer_bits, archive_narrow_klass_shift);
1597 if (UseCompressedOops) {
1598 aot_log_info(aot)(" narrow_oop_mode = %d, narrow_oop_base = " PTR_FORMAT ", narrow_oop_shift = %d",
1599 narrow_oop_mode(), p2i(narrow_oop_base()), narrow_oop_shift());
1600 aot_log_info(aot)(" AOTCompatibleOopCompression = %s", header()->compatible_oop_compression() ? "true" : "false");
1601 }
1602 aot_log_info(aot)("The current max heap size = %zuM, G1HeapRegion::GrainBytes = %zu",
1603 MaxHeapSize/M, G1HeapRegion::GrainBytes);
1604 aot_log_info(aot)(" narrow_klass_base = " PTR_FORMAT ", arrow_klass_pointer_bits = %d, narrow_klass_shift = %d",
1605 p2i(CompressedKlassPointers::base()), CompressedKlassPointers::narrow_klass_pointer_bits(), CompressedKlassPointers::shift());
1606 if (UseCompressedOops) {
1607 aot_log_info(aot)(" narrow_oop_mode = %d, narrow_oop_base = " PTR_FORMAT ", narrow_oop_shift = %d",
1608 CompressedOops::mode(), p2i(CompressedOops::base()), CompressedOops::shift());
1609 aot_log_info(aot)(" AOTCompatibleOopCompression = %s", AOTCompatibleOopCompression ? "true" : "false");
1610 }
1611 if (!object_streaming_mode()) {
1612 aot_log_info(aot)(" heap range = [" PTR_FORMAT " - " PTR_FORMAT "]",
1613 UseCompressedOops ? p2i(CompressedOops::begin()) :
1614 UseG1GC ? p2i((address)G1CollectedHeap::heap()->reserved().start()) : 0L,
1615 UseCompressedOops ? p2i(CompressedOops::end()) :
1616 UseG1GC ? p2i((address)G1CollectedHeap::heap()->reserved().end()) : 0L);
1617 }
1618
1619 int err = 0;
1620 if ( archive_narrow_klass_base != CompressedKlassPointers::base() ||
1621 (err = 1, archive_narrow_klass_pointer_bits != CompressedKlassPointers::narrow_klass_pointer_bits()) ||
1622 (err = 2, archive_narrow_klass_shift != CompressedKlassPointers::shift()) ) {
1623 stringStream ss;
1624 switch (err) {
1625 case 0:
1626 ss.print("Unexpected encoding base encountered (" PTR_FORMAT ", expected " PTR_FORMAT ")",
1627 p2i(CompressedKlassPointers::base()), p2i(archive_narrow_klass_base));
1628 break;
1629 case 1:
1630 ss.print("Unexpected narrow Klass bit length encountered (%d, expected %d)",
1631 CompressedKlassPointers::narrow_klass_pointer_bits(), archive_narrow_klass_pointer_bits);
1632 break;
1633 case 2:
1634 ss.print("Unexpected narrow Klass shift encountered (%d, expected %d)",
1635 CompressedKlassPointers::shift(), archive_narrow_klass_shift);
1636 break;
1637 default:
1638 ShouldNotReachHere();
1639 };
1640 if (CDSConfig::new_aot_flags_used()) {
1641 LogTarget(Info, aot) lt;
1642 if (lt.is_enabled()) {
1643 LogStream ls(lt);
1644 ls.print_raw(ss.base());
1645 header()->print(&ls);
1646 }
1647 } else {
1648 LogTarget(Info, cds) lt;
1649 if (lt.is_enabled()) {
1650 LogStream ls(lt);
1651 ls.print_raw(ss.base());
1652 header()->print(&ls);
1653 }
1654 }
1655 assert(false, "%s", ss.base());
1656 }
1657
1658 return true;
1659 }
1660
1661 #endif // INCLUDE_CDS_JAVA_HEAP
1662
1663 // Unmap a memory region in the address space.
1664
1665 void FileMapInfo::unmap_regions(int regions[], int num_regions) {
1666 for (int r = 0; r < num_regions; r++) {
1667 int idx = regions[r];
1668 unmap_region(idx);
1669 }
1670 }
1671
1672 void FileMapInfo::unmap_region(int i) {
1673 FileMapRegion* r = region_at(i);
1674 char* mapped_base = r->mapped_base();
1675 size_t size = r->used_aligned();
1676
1677 if (mapped_base != nullptr) {
1678 if (size > 0 && r->mapped_from_file()) {
1679 aot_log_info(aot)("Unmapping region #%d at base " INTPTR_FORMAT " (%s)", i, p2i(mapped_base),
1680 shared_region_name[i]);
1681 if (r->in_reserved_space()) {
1682 // This region was mapped inside a ReservedSpace. Its memory will be freed when the ReservedSpace
1683 // is released. Zero it so that we don't accidentally read its content.
1684 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]);
1685 } else {
1686 os::unmap_memory(mapped_base, size);
1687 }
1688 }
1689 r->set_mapped_base(nullptr);
1690 }
1691 }
1692
1693 void FileMapInfo::assert_mark(bool check) {
1694 if (!check) {
1695 AOTMetaspace::unrecoverable_loading_error("Mark mismatch while restoring from shared file.");
1696 }
1697 }
1698
1699 FileMapInfo* FileMapInfo::_current_info = nullptr;
1700 FileMapInfo* FileMapInfo::_dynamic_archive_info = nullptr;
1701 bool FileMapInfo::_memory_mapping_failed = false;
1702
1703 // Open the shared archive file, read and validate the header
1704 // information (version, boot classpath, etc.). If initialization
1705 // fails, shared spaces are disabled and the file is closed.
1706 //
1707 // Validation of the archive is done in two steps:
1708 //
1709 // [1] validate_header() - done here.
1710 // [2] validate_shared_path_table - this is done later, because the table is in the RO
1711 // region of the archive, which is not mapped yet.
1712 bool FileMapInfo::open_as_input() {
1713 assert(CDSConfig::is_using_archive(), "UseSharedSpaces expected.");
1714 assert(Arguments::has_jimage(), "The shared archive file cannot be used with an exploded module build.");
1715
1716 if (JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()) {
1717 // CDS assumes that no classes resolved in vmClasses::resolve_all()
1718 // are replaced at runtime by JVMTI ClassFileLoadHook. All of those classes are resolved
1719 // during the JVMTI "early" stage, so we can still use CDS if
1720 // JvmtiExport::has_early_class_hook_env() is false.
1721 AOTMetaspace::report_loading_error("CDS is disabled because early JVMTI ClassFileLoadHook is in use.");
1722 return false;
1723 }
1724
1725 if (!open_for_read() || !init_from_file(_fd) || !validate_header()) {
1726 if (_is_static) {
1727 AOTMetaspace::report_loading_error("Loading static archive failed.");
1728 return false;
1729 } else {
1730 AOTMetaspace::report_loading_error("Loading dynamic archive failed.");
1731 if (AutoCreateSharedArchive) {
1732 CDSConfig::enable_dumping_dynamic_archive(_full_path);
1733 }
1734 return false;
1735 }
1736 }
1737
1738 return true;
1739 }
1740
1741 bool FileMapInfo::validate_aot_class_linking() {
1742 // These checks need to be done after FileMapInfo::initialize(), which gets called before Universe::heap()
1743 // is available.
1744 if (header()->has_aot_linked_classes()) {
1745 const char* archive_type = CDSConfig::type_of_archive_being_loaded();
1746 CDSConfig::set_has_aot_linked_classes(true);
1747 if (JvmtiExport::should_post_class_file_load_hook()) {
1748 aot_log_error(aot)("%s has aot-linked classes. It cannot be used when JVMTI ClassFileLoadHook is in use.",
1749 archive_type);
1750 return false;
1751 }
1752 if (JvmtiExport::has_early_vmstart_env()) {
1753 aot_log_error(aot)("%s has aot-linked classes. It cannot be used when JVMTI early vm start is in use.",
1754 archive_type);
1755 return false;
1756 }
1757 if (!CDSConfig::is_using_full_module_graph()) {
1758 aot_log_error(aot)("%s has aot-linked classes. It cannot be used when archived full module graph is not used.",
1759 archive_type);
1760 return false;
1761 }
1762
1763 const char* prop = Arguments::get_property("java.security.manager");
1764 if (prop != nullptr && strcmp(prop, "disallow") != 0) {
1765 aot_log_error(aot)("%s has aot-linked classes. It cannot be used with -Djava.security.manager=%s.",
1766 archive_type, prop);
1767 return false;
1768 }
1769
1770 #if INCLUDE_JVMTI
1771 if (Arguments::has_jdwp_agent()) {
1772 aot_log_error(aot)("%s has aot-linked classes. It cannot be used with JDWP agent", archive_type);
1773 return false;
1774 }
1775 #endif
1776 }
1777
1778 return true;
1779 }
1780
1781 // The 2 core spaces are RW->RO
1782 FileMapRegion* FileMapInfo::first_core_region() const {
1783 return region_at(AOTMetaspace::rw);
1784 }
1785
1786 FileMapRegion* FileMapInfo::last_core_region() const {
1787 return region_at(AOTMetaspace::ro);
1788 }
1789
1790 void FileMapInfo::print(outputStream* st) const {
1791 header()->print(st);
1792 if (!is_static()) {
1793 dynamic_header()->print(st);
1794 }
1795 }
1796
1797 int FileMapHeader::compute_crc() {
1798 char* start = (char*)this;
1799 // start computing from the field after _header_size to end of base archive name.
1800 char* buf = (char*)&(_generic_header._header_size) + sizeof(_generic_header._header_size);
1801 size_t sz = header_size() - (buf - start);
1802 int crc = ClassLoader::crc32(0, buf, (jint)sz);
1803 return crc;
1804 }
1805
1806 // This function should only be called during run time with UseSharedSpaces enabled.
1807 bool FileMapHeader::validate() {
1808 const char* file_type = CDSConfig::type_of_archive_being_loaded();
1809 if (_obj_alignment != ObjectAlignmentInBytes) {
1810 AOTMetaspace::report_loading_error("The %s's ObjectAlignmentInBytes of %d"
1811 " does not equal the current ObjectAlignmentInBytes of %d.",
1812 file_type, _obj_alignment, ObjectAlignmentInBytes);
1813 return false;
1814 }
1815 if (_compact_strings != CompactStrings) {
1816 AOTMetaspace::report_loading_error("The %s's CompactStrings setting (%s)"
1817 " does not equal the current CompactStrings setting (%s).", file_type,
1818 _compact_strings ? "enabled" : "disabled",
1819 CompactStrings ? "enabled" : "disabled");
1820 return false;
1821 }
1822 bool jvmci_compiler_is_enabled = CompilerConfig::is_jvmci_compiler_enabled();
1823 CompilerType compiler_type = CompilerConfig::compiler_type();
1824 CompilerType archive_compiler_type = CompilerType(_compiler_type);
1825 // JVMCI compiler does different type profiling settigns and generate
1826 // different code. We can't use archive which was produced
1827 // without it and reverse.
1828 // Only allow mix when JIT compilation is disabled.
1829 // Interpreter is used by default when dumping archive.
1830 bool intepreter_is_used = (archive_compiler_type == CompilerType::compiler_none) ||
1831 (compiler_type == CompilerType::compiler_none);
1832 if (!intepreter_is_used &&
1833 jvmci_compiler_is_enabled != (archive_compiler_type == CompilerType::compiler_jvmci)) {
1834 AOTMetaspace::report_loading_error("The %s's JIT compiler setting (%s)"
1835 " does not equal the current setting (%s).", file_type,
1836 compilertype2name(archive_compiler_type), compilertype2name(compiler_type));
1837 return false;
1838 }
1839 if (TrainingData::have_data()) {
1840 if (_type_profile_level != TypeProfileLevel) {
1841 AOTMetaspace::report_loading_error("The %s's TypeProfileLevel setting (%d)"
1842 " does not equal the current TypeProfileLevel setting (%d).", file_type,
1843 _type_profile_level, TypeProfileLevel);
1844 return false;
1845 }
1846 if (_type_profile_args_limit != TypeProfileArgsLimit) {
1847 AOTMetaspace::report_loading_error("The %s's TypeProfileArgsLimit setting (%d)"
1848 " does not equal the current TypeProfileArgsLimit setting (%d).", file_type,
1849 _type_profile_args_limit, TypeProfileArgsLimit);
1850 return false;
1851 }
1852 if (_type_profile_parms_limit != TypeProfileParmsLimit) {
1853 AOTMetaspace::report_loading_error("The %s's TypeProfileParamsLimit setting (%d)"
1854 " does not equal the current TypeProfileParamsLimit setting (%d).", file_type,
1855 _type_profile_args_limit, TypeProfileArgsLimit);
1856 return false;
1857
1858 }
1859 if (_type_profile_width != TypeProfileWidth) {
1860 AOTMetaspace::report_loading_error("The %s's TypeProfileWidth setting (%d)"
1861 " does not equal the current TypeProfileWidth setting (%d).", file_type,
1862 (int)_type_profile_width, (int)TypeProfileWidth);
1863 return false;
1864
1865 }
1866 if (_bci_profile_width != BciProfileWidth) {
1867 AOTMetaspace::report_loading_error("The %s's BciProfileWidth setting (%d)"
1868 " does not equal the current BciProfileWidth setting (%d).", file_type,
1869 (int)_bci_profile_width, (int)BciProfileWidth);
1870 return false;
1871 }
1872 if (_type_profile_casts != TypeProfileCasts) {
1873 AOTMetaspace::report_loading_error("The %s's TypeProfileCasts setting (%s)"
1874 " does not equal the current TypeProfileCasts setting (%s).", file_type,
1875 _type_profile_casts ? "enabled" : "disabled",
1876 TypeProfileCasts ? "enabled" : "disabled");
1877
1878 return false;
1879
1880 }
1881 if (_profile_traps != ProfileTraps) {
1882 AOTMetaspace::report_loading_error("The %s's ProfileTraps setting (%s)"
1883 " does not equal the current ProfileTraps setting (%s).", file_type,
1884 _profile_traps ? "enabled" : "disabled",
1885 ProfileTraps ? "enabled" : "disabled");
1886
1887 return false;
1888 }
1889 if (_spec_trap_limit_extra_entries != SpecTrapLimitExtraEntries) {
1890 AOTMetaspace::report_loading_error("The %s's SpecTrapLimitExtraEntries setting (%d)"
1891 " does not equal the current SpecTrapLimitExtraEntries setting (%d).", file_type,
1892 _spec_trap_limit_extra_entries, SpecTrapLimitExtraEntries);
1893 return false;
1894
1895 }
1896 }
1897
1898 // This must be done after header validation because it might change the
1899 // header data
1900 const char* prop = Arguments::get_property("java.system.class.loader");
1901 if (prop != nullptr) {
1902 if (has_aot_linked_classes()) {
1903 AOTMetaspace::report_loading_error("%s has aot-linked classes. It cannot be used when the "
1904 "java.system.class.loader property is specified.",
1905 CDSConfig::type_of_archive_being_loaded());
1906 return false;
1907 }
1908 aot_log_warning(aot)("Archived non-system classes are disabled because the "
1909 "java.system.class.loader property is specified (value = \"%s\"). "
1910 "To use archived non-system classes, this property must not be set", prop);
1911 _has_platform_or_app_classes = false;
1912 }
1913
1914
1915 if (!_verify_local && BytecodeVerificationLocal) {
1916 // we cannot load boot classes, so there's no point of using the CDS archive
1917 AOTMetaspace::report_loading_error("The %s's BytecodeVerificationLocal setting (%s)"
1918 " does not equal the current BytecodeVerificationLocal setting (%s).", file_type,
1919 _verify_local ? "enabled" : "disabled",
1920 BytecodeVerificationLocal ? "enabled" : "disabled");
1921 return false;
1922 }
1923
1924 // For backwards compatibility, we don't check the BytecodeVerificationRemote setting
1925 // if the archive only contains system classes.
1926 if (_has_platform_or_app_classes
1927 && !_verify_remote // we didn't verify the archived platform/app classes
1928 && BytecodeVerificationRemote) { // but we want to verify all loaded platform/app classes
1929 aot_log_info(aot)("The %s was created with less restrictive "
1930 "verification setting than the current setting.", file_type);
1931 // Pretend that we didn't have any archived platform/app classes, so they won't be loaded
1932 // by SystemDictionaryShared.
1933 _has_platform_or_app_classes = false;
1934 }
1935
1936 aot_log_info(aot)("The %s was created with UseCompressedOops = %d, UseCompactObjectHeaders = %d",
1937 file_type, compressed_oops(), compact_headers());
1938 if (compressed_oops() != UseCompressedOops) {
1939 aot_log_warning(aot)("Unable to use %s.\nThe saved state of UseCompressedOops (%d) is "
1940 "different from runtime (%d), CDS will be disabled.", file_type,
1941 compressed_oops(), UseCompressedOops);
1942 return false;
1943 }
1944
1945 if (compact_headers() != UseCompactObjectHeaders) {
1946 aot_log_warning(aot)("Unable to use %s.\nThe %s's UseCompactObjectHeaders setting (%s)"
1947 " does not equal the current UseCompactObjectHeaders setting (%s).", file_type, file_type,
1948 _compact_headers ? "enabled" : "disabled",
1949 UseCompactObjectHeaders ? "enabled" : "disabled");
1950 return false;
1951 }
1952
1953 if (!_use_optimized_module_handling && !CDSConfig::is_dumping_final_static_archive()) {
1954 CDSConfig::stop_using_optimized_module_handling();
1955 aot_log_info(aot)("optimized module handling: disabled because archive was created without optimized module handling");
1956 }
1957
1958 if (is_static()) {
1959 // Only the static archive can contain the full module graph.
1960 if (!_has_full_module_graph) {
1961 CDSConfig::stop_using_full_module_graph("archive was created without full module graph");
1962 }
1963 }
1964
1965 return true;
1966 }
1967
1968 bool FileMapInfo::validate_header() {
1969 if (!header()->validate()) {
1970 return false;
1971 }
1972 if (_is_static) {
1973 return true;
1974 } else {
1975 return DynamicArchive::validate(this);
1976 }
1977 }
1978
1979 #if INCLUDE_JVMTI
1980 ClassPathEntry** FileMapInfo::_classpath_entries_for_jvmti = nullptr;
1981
1982 ClassPathEntry* FileMapInfo::get_classpath_entry_for_jvmti(int i, TRAPS) {
1983 if (i == 0) {
1984 // index 0 corresponds to the ClassPathImageEntry which is a globally shared object
1985 // and should never be deleted.
1986 return ClassLoader::get_jrt_entry();
1987 }
1988 ClassPathEntry* ent = _classpath_entries_for_jvmti[i];
1989 if (ent == nullptr) {
1990 const AOTClassLocation* cl = AOTClassLocationConfig::runtime()->class_location_at(i);
1991 const char* path = cl->path();
1992 struct stat st;
1993 if (os::stat(path, &st) != 0) {
1994 char *msg = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, strlen(path) + 128);
1995 jio_snprintf(msg, strlen(path) + 127, "error in finding JAR file %s", path);
1996 THROW_MSG_(vmSymbols::java_io_IOException(), msg, nullptr);
1997 } else {
1998 ent = ClassLoader::create_class_path_entry(THREAD, path, &st);
1999 if (ent == nullptr) {
2000 char *msg = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, strlen(path) + 128);
2001 jio_snprintf(msg, strlen(path) + 127, "error in opening JAR file %s", path);
2002 THROW_MSG_(vmSymbols::java_io_IOException(), msg, nullptr);
2003 }
2004 }
2005
2006 MutexLocker mu(THREAD, CDSClassFileStream_lock);
2007 if (_classpath_entries_for_jvmti[i] == nullptr) {
2008 _classpath_entries_for_jvmti[i] = ent;
2009 } else {
2010 // Another thread has beat me to creating this entry
2011 delete ent;
2012 ent = _classpath_entries_for_jvmti[i];
2013 }
2014 }
2015
2016 return ent;
2017 }
2018
2019 ClassFileStream* FileMapInfo::open_stream_for_jvmti(InstanceKlass* ik, Handle class_loader, TRAPS) {
2020 int path_index = ik->shared_classpath_index();
2021 assert(path_index >= 0, "should be called for shared built-in classes only");
2022 assert(path_index < AOTClassLocationConfig::runtime()->length(), "sanity");
2023
2024 ClassPathEntry* cpe = get_classpath_entry_for_jvmti(path_index, CHECK_NULL);
2025 assert(cpe != nullptr, "must be");
2026
2027 Symbol* name = ik->name();
2028 const char* const class_name = name->as_C_string();
2029 const char* const file_name = ClassLoader::file_name_for_class_name(class_name,
2030 name->utf8_length());
2031 ClassLoaderData* loader_data = ClassLoaderData::class_loader_data(class_loader());
2032 const AOTClassLocation* cl = AOTClassLocationConfig::runtime()->class_location_at(path_index);
2033 ClassFileStream* cfs;
2034 if (class_loader() != nullptr && cl->is_multi_release_jar()) {
2035 // This class was loaded from a multi-release JAR file during dump time. The
2036 // process for finding its classfile is complex. Let's defer to the Java code
2037 // in java.lang.ClassLoader.
2038 cfs = get_stream_from_class_loader(class_loader, cpe, file_name, CHECK_NULL);
2039 } else {
2040 cfs = cpe->open_stream_for_loader(THREAD, file_name, loader_data);
2041 }
2042 assert(cfs != nullptr, "must be able to read the classfile data of shared classes for built-in loaders.");
2043 log_debug(aot, jvmti)("classfile data for %s [%d: %s] = %d bytes", class_name, path_index,
2044 cfs->source(), cfs->length());
2045 return cfs;
2046 }
2047
2048 ClassFileStream* FileMapInfo::get_stream_from_class_loader(Handle class_loader,
2049 ClassPathEntry* cpe,
2050 const char* file_name,
2051 TRAPS) {
2052 JavaValue result(T_OBJECT);
2053 oop class_name = java_lang_String::create_oop_from_str(file_name, THREAD);
2054 Handle h_class_name = Handle(THREAD, class_name);
2055
2056 // byte[] ClassLoader.getResourceAsByteArray(String name)
2057 JavaCalls::call_virtual(&result,
2058 class_loader,
2059 vmClasses::ClassLoader_klass(),
2060 vmSymbols::getResourceAsByteArray_name(),
2061 vmSymbols::getResourceAsByteArray_signature(),
2062 h_class_name,
2063 CHECK_NULL);
2064 assert(result.get_type() == T_OBJECT, "just checking");
2065 oop obj = result.get_oop();
2066 assert(obj != nullptr, "ClassLoader.getResourceAsByteArray should not return null");
2067
2068 // copy from byte[] to a buffer
2069 typeArrayOop ba = typeArrayOop(obj);
2070 jint len = ba->length();
2071 u1* buffer = NEW_RESOURCE_ARRAY(u1, len);
2072 ArrayAccess<>::arraycopy_to_native<>(ba, typeArrayOopDesc::element_offset<jbyte>(0), buffer, len);
2073
2074 return new ClassFileStream(buffer, len, cpe->name());
2075 }
2076 #endif