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