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