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