1 /*
2 * Copyright (c) 2003, 2024, 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 "precompiled.hpp"
26 #include "cds/archiveBuilder.hpp"
27 #include "cds/archiveHeapLoader.inline.hpp"
28 #include "cds/archiveHeapWriter.hpp"
29 #include "cds/archiveUtils.inline.hpp"
30 #include "cds/cds_globals.hpp"
31 #include "cds/cdsConfig.hpp"
32 #include "cds/dynamicArchive.hpp"
33 #include "cds/filemap.hpp"
34 #include "cds/heapShared.hpp"
35 #include "cds/metaspaceShared.hpp"
36 #include "classfile/altHashing.hpp"
37 #include "classfile/classFileStream.hpp"
38 #include "classfile/classLoader.hpp"
39 #include "classfile/classLoader.inline.hpp"
40 #include "classfile/classLoaderData.inline.hpp"
41 #include "classfile/classLoaderExt.hpp"
42 #include "classfile/symbolTable.hpp"
43 #include "classfile/systemDictionaryShared.hpp"
44 #include "classfile/vmClasses.hpp"
45 #include "classfile/vmSymbols.hpp"
46 #include "jvm.h"
47 #include "logging/log.hpp"
48 #include "logging/logMessage.hpp"
49 #include "logging/logStream.hpp"
50 #include "memory/iterator.inline.hpp"
51 #include "memory/metadataFactory.hpp"
52 #include "memory/metaspaceClosure.hpp"
53 #include "memory/oopFactory.hpp"
54 #include "memory/universe.hpp"
55 #include "nmt/memTracker.hpp"
56 #include "oops/compressedOops.hpp"
57 #include "oops/compressedOops.inline.hpp"
58 #include "oops/objArrayOop.hpp"
59 #include "oops/oop.inline.hpp"
60 #include "prims/jvmtiExport.hpp"
61 #include "runtime/arguments.hpp"
62 #include "runtime/globals_extension.hpp"
63 #include "runtime/java.hpp"
64 #include "runtime/mutexLocker.hpp"
65 #include "runtime/os.hpp"
66 #include "runtime/vm_version.hpp"
67 #include "utilities/align.hpp"
68 #include "utilities/bitMap.inline.hpp"
69 #include "utilities/classpathStream.hpp"
70 #include "utilities/defaultStream.hpp"
71 #include "utilities/ostream.hpp"
72 #if INCLUDE_G1GC
73 #include "gc/g1/g1CollectedHeap.hpp"
74 #include "gc/g1/g1HeapRegion.hpp"
75 #endif
76
77 # include <sys/stat.h>
78 # include <errno.h>
79
80 #ifndef O_BINARY // if defined (Win32) use binary files.
81 #define O_BINARY 0 // otherwise do nothing.
82 #endif
83
84 // Fill in the fileMapInfo structure with data about this VM instance.
85
86 // This method copies the vm version info into header_version. If the version is too
87 // long then a truncated version, which has a hash code appended to it, is copied.
88 //
89 // Using a template enables this method to verify that header_version is an array of
90 // length JVM_IDENT_MAX. This ensures that the code that writes to the CDS file and
91 // the code that reads the CDS file will both use the same size buffer. Hence, will
92 // use identical truncation. This is necessary for matching of truncated versions.
93 template <int N> static void get_header_version(char (&header_version) [N]) {
94 assert(N == JVM_IDENT_MAX, "Bad header_version size");
95
96 const char *vm_version = VM_Version::internal_vm_info_string();
97 const int version_len = (int)strlen(vm_version);
98
99 memset(header_version, 0, JVM_IDENT_MAX);
100
101 if (version_len < (JVM_IDENT_MAX-1)) {
102 strcpy(header_version, vm_version);
103
104 } else {
105 // Get the hash value. Use a static seed because the hash needs to return the same
106 // value over multiple jvm invocations.
107 uint32_t hash = AltHashing::halfsiphash_32(8191, (const uint8_t*)vm_version, version_len);
108
109 // Truncate the ident, saving room for the 8 hex character hash value.
110 strncpy(header_version, vm_version, JVM_IDENT_MAX-9);
111
112 // Append the hash code as eight hex digits.
113 os::snprintf_checked(&header_version[JVM_IDENT_MAX-9], 9, "%08x", hash);
114 header_version[JVM_IDENT_MAX-1] = 0; // Null terminate.
115 }
116
117 assert(header_version[JVM_IDENT_MAX-1] == 0, "must be");
118 }
119
120 FileMapInfo::FileMapInfo(const char* full_path, bool is_static) :
121 _is_static(is_static), _file_open(false), _is_mapped(false), _fd(-1), _file_offset(0),
122 _full_path(full_path), _base_archive_name(nullptr), _header(nullptr) {
123 if (_is_static) {
124 assert(_current_info == nullptr, "must be singleton"); // not thread safe
125 _current_info = this;
126 } else {
127 assert(_dynamic_archive_info == nullptr, "must be singleton"); // not thread safe
128 _dynamic_archive_info = this;
129 }
130 }
131
132 FileMapInfo::~FileMapInfo() {
133 if (_is_static) {
134 assert(_current_info == this, "must be singleton"); // not thread safe
135 _current_info = nullptr;
136 } else {
137 assert(_dynamic_archive_info == this, "must be singleton"); // not thread safe
138 _dynamic_archive_info = nullptr;
139 }
140
141 if (_header != nullptr) {
142 os::free(_header);
143 }
144
145 if (_file_open) {
146 ::close(_fd);
147 }
148 }
149
150 void FileMapInfo::populate_header(size_t core_region_alignment) {
151 assert(_header == nullptr, "Sanity check");
152 size_t c_header_size;
153 size_t header_size;
154 size_t base_archive_name_size = 0;
155 size_t base_archive_name_offset = 0;
156 size_t longest_common_prefix_size = 0;
157 if (is_static()) {
158 c_header_size = sizeof(FileMapHeader);
159 header_size = c_header_size;
160 } else {
161 // dynamic header including base archive name for non-default base archive
162 c_header_size = sizeof(DynamicArchiveHeader);
163 header_size = c_header_size;
164
165 const char* default_base_archive_name = CDSConfig::default_archive_path();
166 const char* current_base_archive_name = CDSConfig::static_archive_path();
167 if (!os::same_files(current_base_archive_name, default_base_archive_name)) {
168 base_archive_name_size = strlen(current_base_archive_name) + 1;
169 header_size += base_archive_name_size;
170 base_archive_name_offset = c_header_size;
171 }
172 }
173 ResourceMark rm;
174 GrowableArray<const char*>* app_cp_array = create_dumptime_app_classpath_array();
175 int len = app_cp_array->length();
176 longest_common_prefix_size = longest_common_app_classpath_prefix_len(len, app_cp_array);
177 _header = (FileMapHeader*)os::malloc(header_size, mtInternal);
178 memset((void*)_header, 0, header_size);
179 _header->populate(this,
180 core_region_alignment,
181 header_size,
182 base_archive_name_size,
183 base_archive_name_offset,
184 longest_common_prefix_size);
185 }
186
187 void FileMapHeader::populate(FileMapInfo *info, size_t core_region_alignment,
188 size_t header_size, size_t base_archive_name_size,
189 size_t base_archive_name_offset, size_t common_app_classpath_prefix_size) {
190 // 1. We require _generic_header._magic to be at the beginning of the file
191 // 2. FileMapHeader also assumes that _generic_header is at the beginning of the file
192 assert(offset_of(FileMapHeader, _generic_header) == 0, "must be");
193 set_header_size((unsigned int)header_size);
194 set_base_archive_name_offset((unsigned int)base_archive_name_offset);
195 set_base_archive_name_size((unsigned int)base_archive_name_size);
196 set_common_app_classpath_prefix_size((unsigned int)common_app_classpath_prefix_size);
197 set_magic(CDSConfig::is_dumping_dynamic_archive() ? CDS_DYNAMIC_ARCHIVE_MAGIC : CDS_ARCHIVE_MAGIC);
198 set_version(CURRENT_CDS_ARCHIVE_VERSION);
199
200 if (!info->is_static() && base_archive_name_size != 0) {
201 // copy base archive name
202 copy_base_archive_name(CDSConfig::static_archive_path());
203 }
204 _core_region_alignment = core_region_alignment;
205 _obj_alignment = ObjectAlignmentInBytes;
206 _compact_strings = CompactStrings;
207 if (CDSConfig::is_dumping_heap()) {
208 _narrow_oop_mode = CompressedOops::mode();
209 _narrow_oop_base = CompressedOops::base();
210 _narrow_oop_shift = CompressedOops::shift();
211 }
212 _compressed_oops = UseCompressedOops;
213 _compressed_class_ptrs = UseCompressedClassPointers;
214 _max_heap_size = MaxHeapSize;
215 _use_optimized_module_handling = CDSConfig::is_using_optimized_module_handling();
216 _has_full_module_graph = CDSConfig::is_dumping_full_module_graph();
217
218 // The following fields are for sanity checks for whether this archive
219 // will function correctly with this JVM and the bootclasspath it's
220 // invoked with.
221
222 // JVM version string ... changes on each build.
223 get_header_version(_jvm_ident);
224
225 _app_class_paths_start_index = ClassLoaderExt::app_class_paths_start_index();
226 _app_module_paths_start_index = ClassLoaderExt::app_module_paths_start_index();
227 _max_used_path_index = ClassLoaderExt::max_used_path_index();
228 _num_module_paths = ClassLoader::num_module_path_entries();
229
230 _verify_local = BytecodeVerificationLocal;
231 _verify_remote = BytecodeVerificationRemote;
232 _has_platform_or_app_classes = ClassLoaderExt::has_platform_or_app_classes();
233 _has_non_jar_in_classpath = ClassLoaderExt::has_non_jar_in_classpath();
234 _requested_base_address = (char*)SharedBaseAddress;
235 _mapped_base_address = (char*)SharedBaseAddress;
236 _allow_archiving_with_java_agent = AllowArchivingWithJavaAgent;
237
238 if (!CDSConfig::is_dumping_dynamic_archive()) {
239 set_shared_path_table(info->_shared_path_table);
240 }
241 }
242
243 void FileMapHeader::copy_base_archive_name(const char* archive) {
244 assert(base_archive_name_size() != 0, "_base_archive_name_size not set");
245 assert(base_archive_name_offset() != 0, "_base_archive_name_offset not set");
246 assert(header_size() > sizeof(*this), "_base_archive_name_size not included in header size?");
247 memcpy((char*)this + base_archive_name_offset(), archive, base_archive_name_size());
248 }
249
250 void FileMapHeader::print(outputStream* st) {
251 ResourceMark rm;
252
253 st->print_cr("- magic: 0x%08x", magic());
254 st->print_cr("- crc: 0x%08x", crc());
255 st->print_cr("- version: 0x%x", version());
256 st->print_cr("- header_size: " UINT32_FORMAT, header_size());
257 st->print_cr("- common_app_classpath_size: " UINT32_FORMAT, common_app_classpath_prefix_size());
258 st->print_cr("- base_archive_name_offset: " UINT32_FORMAT, base_archive_name_offset());
259 st->print_cr("- base_archive_name_size: " UINT32_FORMAT, base_archive_name_size());
260
261 for (int i = 0; i < NUM_CDS_REGIONS; i++) {
262 FileMapRegion* r = region_at(i);
263 r->print(st, i);
264 }
265 st->print_cr("============ end regions ======== ");
266
267 st->print_cr("- core_region_alignment: " SIZE_FORMAT, _core_region_alignment);
268 st->print_cr("- obj_alignment: %d", _obj_alignment);
269 st->print_cr("- narrow_oop_base: " INTPTR_FORMAT, p2i(_narrow_oop_base));
270 st->print_cr("- narrow_oop_shift %d", _narrow_oop_shift);
271 st->print_cr("- compact_strings: %d", _compact_strings);
272 st->print_cr("- max_heap_size: " UINTX_FORMAT, _max_heap_size);
273 st->print_cr("- narrow_oop_mode: %d", _narrow_oop_mode);
274 st->print_cr("- compressed_oops: %d", _compressed_oops);
275 st->print_cr("- compressed_class_ptrs: %d", _compressed_class_ptrs);
276 st->print_cr("- cloned_vtables_offset: " SIZE_FORMAT_X, _cloned_vtables_offset);
277 st->print_cr("- serialized_data_offset: " SIZE_FORMAT_X, _serialized_data_offset);
278 st->print_cr("- jvm_ident: %s", _jvm_ident);
279 st->print_cr("- shared_path_table_offset: " SIZE_FORMAT_X, _shared_path_table_offset);
280 st->print_cr("- app_class_paths_start_index: %d", _app_class_paths_start_index);
281 st->print_cr("- app_module_paths_start_index: %d", _app_module_paths_start_index);
282 st->print_cr("- num_module_paths: %d", _num_module_paths);
283 st->print_cr("- max_used_path_index: %d", _max_used_path_index);
284 st->print_cr("- verify_local: %d", _verify_local);
285 st->print_cr("- verify_remote: %d", _verify_remote);
286 st->print_cr("- has_platform_or_app_classes: %d", _has_platform_or_app_classes);
287 st->print_cr("- has_non_jar_in_classpath: %d", _has_non_jar_in_classpath);
288 st->print_cr("- requested_base_address: " INTPTR_FORMAT, p2i(_requested_base_address));
289 st->print_cr("- mapped_base_address: " INTPTR_FORMAT, p2i(_mapped_base_address));
290 st->print_cr("- heap_root_segments.roots_count: %d" , _heap_root_segments.roots_count());
291 st->print_cr("- heap_root_segments.base_offset: " SIZE_FORMAT_X, _heap_root_segments.base_offset());
292 st->print_cr("- heap_root_segments.count: " SIZE_FORMAT, _heap_root_segments.count());
293 st->print_cr("- heap_root_segments.max_size_elems: %d", _heap_root_segments.max_size_in_elems());
294 st->print_cr("- heap_root_segments.max_size_bytes: %d", _heap_root_segments.max_size_in_bytes());
295 st->print_cr("- _heap_oopmap_start_pos: " SIZE_FORMAT, _heap_oopmap_start_pos);
296 st->print_cr("- _heap_ptrmap_start_pos: " SIZE_FORMAT, _heap_ptrmap_start_pos);
297 st->print_cr("- _rw_ptrmap_start_pos: " SIZE_FORMAT, _rw_ptrmap_start_pos);
298 st->print_cr("- _ro_ptrmap_start_pos: " SIZE_FORMAT, _ro_ptrmap_start_pos);
299 st->print_cr("- allow_archiving_with_java_agent:%d", _allow_archiving_with_java_agent);
300 st->print_cr("- use_optimized_module_handling: %d", _use_optimized_module_handling);
301 st->print_cr("- has_full_module_graph %d", _has_full_module_graph);
302 }
303
304 void SharedClassPathEntry::init_as_non_existent(const char* path, TRAPS) {
305 _type = non_existent_entry;
306 set_name(path, CHECK);
307 }
308
309 void SharedClassPathEntry::init(bool is_modules_image,
310 bool is_module_path,
311 ClassPathEntry* cpe, TRAPS) {
312 assert(CDSConfig::is_dumping_archive(), "sanity");
313 _timestamp = 0;
314 _filesize = 0;
315 _from_class_path_attr = false;
316
317 struct stat st;
318 if (os::stat(cpe->name(), &st) == 0) {
319 if ((st.st_mode & S_IFMT) == S_IFDIR) {
320 _type = dir_entry;
321 } else {
322 // The timestamp of the modules_image is not checked at runtime.
323 if (is_modules_image) {
324 _type = modules_image_entry;
325 } else {
326 _type = jar_entry;
327 _timestamp = st.st_mtime;
328 _from_class_path_attr = cpe->from_class_path_attr();
329 }
330 _filesize = st.st_size;
331 _is_module_path = is_module_path;
332 }
333 } else {
334 // The file/dir must exist, or it would not have been added
335 // into ClassLoader::classpath_entry().
336 //
337 // If we can't access a jar file in the boot path, then we can't
338 // make assumptions about where classes get loaded from.
339 log_error(cds)("Unable to open file %s.", cpe->name());
340 MetaspaceShared::unrecoverable_loading_error();
341 }
342
343 // No need to save the name of the module file, as it will be computed at run time
344 // to allow relocation of the JDK directory.
345 const char* name = is_modules_image ? "" : cpe->name();
346 set_name(name, CHECK);
347 }
348
349 void SharedClassPathEntry::set_name(const char* name, TRAPS) {
350 size_t len = strlen(name) + 1;
351 _name = MetadataFactory::new_array<char>(ClassLoaderData::the_null_class_loader_data(), (int)len, CHECK);
352 strcpy(_name->data(), name);
353 }
354
355 void SharedClassPathEntry::copy_from(SharedClassPathEntry* ent, ClassLoaderData* loader_data, TRAPS) {
356 assert(ent != nullptr, "sanity");
357 _type = ent->_type;
358 _is_module_path = ent->_is_module_path;
359 _timestamp = ent->_timestamp;
360 _filesize = ent->_filesize;
361 _from_class_path_attr = ent->_from_class_path_attr;
362 set_name(ent->name(), CHECK);
363
364 if (ent->is_jar() && ent->manifest() != nullptr) {
365 Array<u1>* buf = MetadataFactory::new_array<u1>(loader_data,
366 ent->manifest_size(),
367 CHECK);
368 char* p = (char*)(buf->data());
369 memcpy(p, ent->manifest(), ent->manifest_size());
370 set_manifest(buf);
371 }
372 }
373
374 const char* SharedClassPathEntry::name() const {
375 if (CDSConfig::is_using_archive() && is_modules_image()) {
376 // In order to validate the runtime modules image file size against the archived
377 // size information, we need to obtain the runtime modules image path. The recorded
378 // dump time modules image path in the archive may be different from the runtime path
379 // if the JDK image has beed moved after generating the archive.
380 return ClassLoader::get_jrt_entry()->name();
381 } else {
382 return _name->data();
383 }
384 }
385
386 bool SharedClassPathEntry::validate(bool is_class_path) const {
387 assert(CDSConfig::is_using_archive(), "runtime only");
388
389 struct stat st;
390 const char* name = this->name();
391
392 bool ok = true;
393 log_info(class, path)("checking shared classpath entry: %s", name);
394 if (os::stat(name, &st) != 0 && is_class_path) {
395 // If the archived module path entry does not exist at runtime, it is not fatal
396 // (no need to invalid the shared archive) because the shared runtime visibility check
397 // filters out any archived module classes that do not have a matching runtime
398 // module path location.
399 log_warning(cds)("Required classpath entry does not exist: %s", name);
400 ok = false;
401 } else if (is_dir()) {
402 if (!os::dir_is_empty(name)) {
403 log_warning(cds)("directory is not empty: %s", name);
404 ok = false;
405 }
406 } else {
407 bool size_differs = _filesize != st.st_size;
408 bool time_differs = has_timestamp() && _timestamp != st.st_mtime;
409 if (time_differs || size_differs) {
410 ok = false;
411 if (PrintSharedArchiveAndExit) {
412 log_warning(cds)(time_differs ? "Timestamp mismatch" : "File size mismatch");
413 } else {
414 const char* bad_file_msg = "This file is not the one used while building the shared archive file:";
415 log_warning(cds)("%s %s", bad_file_msg, name);
416 if (!log_is_enabled(Info, cds)) {
417 log_warning(cds)("%s %s", bad_file_msg, name);
418 }
419 if (time_differs) {
420 log_warning(cds)("%s timestamp has changed.", name);
421 }
422 if (size_differs) {
423 log_warning(cds)("%s size has changed.", name);
424 }
425 }
426 }
427 }
428
429 if (PrintSharedArchiveAndExit && !ok) {
430 // If PrintSharedArchiveAndExit is enabled, don't report failure to the
431 // caller. Please see above comments for more details.
432 ok = true;
433 MetaspaceShared::set_archive_loading_failed();
434 }
435 return ok;
436 }
437
438 bool SharedClassPathEntry::check_non_existent() const {
439 assert(_type == non_existent_entry, "must be");
440 log_info(class, path)("should be non-existent: %s", name());
441 struct stat st;
442 if (os::stat(name(), &st) != 0) {
443 log_info(class, path)("ok");
444 return true; // file doesn't exist
445 } else {
446 return false;
447 }
448 }
449
450 void SharedClassPathEntry::metaspace_pointers_do(MetaspaceClosure* it) {
451 it->push(&_name);
452 it->push(&_manifest);
453 }
454
455 void SharedPathTable::metaspace_pointers_do(MetaspaceClosure* it) {
456 it->push(&_entries);
457 }
458
459 void SharedPathTable::dumptime_init(ClassLoaderData* loader_data, TRAPS) {
460 const int num_entries =
461 ClassLoader::num_boot_classpath_entries() +
462 ClassLoader::num_app_classpath_entries() +
463 ClassLoader::num_module_path_entries() +
464 FileMapInfo::num_non_existent_class_paths();
465 _entries = MetadataFactory::new_array<SharedClassPathEntry*>(loader_data, num_entries, CHECK);
466 for (int i = 0; i < num_entries; i++) {
467 SharedClassPathEntry* ent =
468 new (loader_data, SharedClassPathEntry::size(), MetaspaceObj::SharedClassPathEntryType, THREAD) SharedClassPathEntry;
469 _entries->at_put(i, ent);
470 }
471 }
472
473 void FileMapInfo::allocate_shared_path_table(TRAPS) {
474 assert(CDSConfig::is_dumping_archive(), "sanity");
475
476 ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();
477 ClassPathEntry* jrt = ClassLoader::get_jrt_entry();
478
479 assert(jrt != nullptr,
480 "No modular java runtime image present when allocating the CDS classpath entry table");
481
482 _shared_path_table.dumptime_init(loader_data, CHECK);
483
484 // 1. boot class path
485 int i = 0;
486 i = add_shared_classpaths(i, "boot", jrt, CHECK);
487 i = add_shared_classpaths(i, "app", ClassLoader::app_classpath_entries(), CHECK);
488 i = add_shared_classpaths(i, "module", ClassLoader::module_path_entries(), CHECK);
489
490 for (int x = 0; x < num_non_existent_class_paths(); x++, i++) {
491 const char* path = _non_existent_class_paths->at(x);
492 shared_path(i)->init_as_non_existent(path, CHECK);
493 }
494
495 assert(i == _shared_path_table.size(), "number of shared path entry mismatch");
496 }
497
498 int FileMapInfo::add_shared_classpaths(int i, const char* which, ClassPathEntry *cpe, TRAPS) {
499 while (cpe != nullptr) {
500 bool is_jrt = (cpe == ClassLoader::get_jrt_entry());
501 bool is_module_path = i >= ClassLoaderExt::app_module_paths_start_index();
502 const char* type = (is_jrt ? "jrt" : (cpe->is_jar_file() ? "jar" : "dir"));
503 log_info(class, path)("add %s shared path (%s) %s", which, type, cpe->name());
504 SharedClassPathEntry* ent = shared_path(i);
505 ent->init(is_jrt, is_module_path, cpe, CHECK_0);
506 if (cpe->is_jar_file()) {
507 update_jar_manifest(cpe, ent, CHECK_0);
508 }
509 if (is_jrt) {
510 cpe = ClassLoader::get_next_boot_classpath_entry(cpe);
511 } else {
512 cpe = cpe->next();
513 }
514 i++;
515 }
516
517 return i;
518 }
519
520 void FileMapInfo::check_nonempty_dir_in_shared_path_table() {
521 assert(CDSConfig::is_dumping_archive(), "sanity");
522
523 bool has_nonempty_dir = false;
524
525 int last = _shared_path_table.size() - 1;
526 if (last > ClassLoaderExt::max_used_path_index()) {
527 // no need to check any path beyond max_used_path_index
528 last = ClassLoaderExt::max_used_path_index();
529 }
530
531 for (int i = 0; i <= last; i++) {
532 SharedClassPathEntry *e = shared_path(i);
533 if (e->is_dir()) {
534 const char* path = e->name();
535 if (!os::dir_is_empty(path)) {
536 log_error(cds)("Error: non-empty directory '%s'", path);
537 has_nonempty_dir = true;
538 }
539 }
540 }
541
542 if (has_nonempty_dir) {
543 ClassLoader::exit_with_path_failure("Cannot have non-empty directory in paths", nullptr);
544 }
545 }
546
547 void FileMapInfo::record_non_existent_class_path_entry(const char* path) {
548 assert(CDSConfig::is_dumping_archive(), "sanity");
549 log_info(class, path)("non-existent Class-Path entry %s", path);
550 if (_non_existent_class_paths == nullptr) {
551 _non_existent_class_paths = new (mtClass) GrowableArray<const char*>(10, mtClass);
552 }
553 _non_existent_class_paths->append(os::strdup(path));
554 }
555
556 int FileMapInfo::num_non_existent_class_paths() {
557 assert(CDSConfig::is_dumping_archive(), "sanity");
558 if (_non_existent_class_paths != nullptr) {
559 return _non_existent_class_paths->length();
560 } else {
561 return 0;
562 }
563 }
564
565 int FileMapInfo::get_module_shared_path_index(Symbol* location) {
566 if (location->starts_with("jrt:", 4) && get_number_of_shared_paths() > 0) {
567 assert(shared_path(0)->is_modules_image(), "first shared_path must be the modules image");
568 return 0;
569 }
570
571 if (ClassLoaderExt::app_module_paths_start_index() >= get_number_of_shared_paths()) {
572 // The archive(s) were created without --module-path option
573 return -1;
574 }
575
576 if (!location->starts_with("file:", 5)) {
577 return -1;
578 }
579
580 // skip_uri_protocol was also called during dump time -- see ClassLoaderExt::process_module_table()
581 ResourceMark rm;
582 const char* file = ClassLoader::uri_to_path(location->as_C_string());
583 for (int i = ClassLoaderExt::app_module_paths_start_index(); i < get_number_of_shared_paths(); i++) {
584 SharedClassPathEntry* ent = shared_path(i);
585 if (!ent->is_non_existent()) {
586 assert(ent->in_named_module(), "must be");
587 bool cond = strcmp(file, ent->name()) == 0;
588 log_debug(class, path)("get_module_shared_path_index (%d) %s : %s = %s", i,
589 location->as_C_string(), ent->name(), cond ? "same" : "different");
590 if (cond) {
591 return i;
592 }
593 }
594 }
595
596 return -1;
597 }
598
599 class ManifestStream: public ResourceObj {
600 private:
601 u1* _buffer_start; // Buffer bottom
602 u1* _buffer_end; // Buffer top (one past last element)
603 u1* _current; // Current buffer position
604
605 public:
606 // Constructor
607 ManifestStream(u1* buffer, int length) : _buffer_start(buffer),
608 _current(buffer) {
609 _buffer_end = buffer + length;
610 }
611
612 static bool is_attr(u1* attr, const char* name) {
613 return strncmp((const char*)attr, name, strlen(name)) == 0;
614 }
615
616 static char* copy_attr(u1* value, size_t len) {
617 char* buf = NEW_RESOURCE_ARRAY(char, len + 1);
618 strncpy(buf, (char*)value, len);
619 buf[len] = 0;
620 return buf;
621 }
622 };
623
624 void FileMapInfo::update_jar_manifest(ClassPathEntry *cpe, SharedClassPathEntry* ent, TRAPS) {
625 ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();
626 ResourceMark rm(THREAD);
627 jint manifest_size;
628
629 assert(cpe->is_jar_file() && ent->is_jar(), "the shared class path entry is not a JAR file");
630 char* manifest = ClassLoaderExt::read_manifest(THREAD, cpe, &manifest_size);
631 if (manifest != nullptr) {
632 ManifestStream* stream = new ManifestStream((u1*)manifest,
633 manifest_size);
634 // Copy the manifest into the shared archive
635 manifest = ClassLoaderExt::read_raw_manifest(THREAD, cpe, &manifest_size);
636 Array<u1>* buf = MetadataFactory::new_array<u1>(loader_data,
637 manifest_size,
638 CHECK);
639 char* p = (char*)(buf->data());
640 memcpy(p, manifest, manifest_size);
641 ent->set_manifest(buf);
642 }
643 }
644
645 char* FileMapInfo::skip_first_path_entry(const char* path) {
646 size_t path_sep_len = strlen(os::path_separator());
647 char* p = strstr((char*)path, os::path_separator());
648 if (p != nullptr) {
649 debug_only( {
650 size_t image_name_len = strlen(MODULES_IMAGE_NAME);
651 assert(strncmp(p - image_name_len, MODULES_IMAGE_NAME, image_name_len) == 0,
652 "first entry must be the modules image");
653 } );
654 p += path_sep_len;
655 } else {
656 debug_only( {
657 assert(ClassLoader::string_ends_with(path, MODULES_IMAGE_NAME),
658 "first entry must be the modules image");
659 } );
660 }
661 return p;
662 }
663
664 int FileMapInfo::num_paths(const char* path) {
665 if (path == nullptr) {
666 return 0;
667 }
668 int npaths = 1;
669 char* p = (char*)path;
670 while (p != nullptr) {
671 char* prev = p;
672 p = strstr((char*)p, os::path_separator());
673 if (p != nullptr) {
674 p++;
675 // don't count empty path
676 if ((p - prev) > 1) {
677 npaths++;
678 }
679 }
680 }
681 return npaths;
682 }
683
684 // Returns true if a path within the paths exists and has non-zero size.
685 bool FileMapInfo::check_paths_existence(const char* paths) {
686 ClasspathStream cp_stream(paths);
687 bool exist = false;
688 struct stat st;
689 while (cp_stream.has_next()) {
690 const char* path = cp_stream.get_next();
691 if (os::stat(path, &st) == 0 && st.st_size > 0) {
692 exist = true;
693 break;
694 }
695 }
696 return exist;
697 }
698
699 GrowableArray<const char*>* FileMapInfo::create_dumptime_app_classpath_array() {
700 assert(CDSConfig::is_dumping_archive(), "sanity");
701 GrowableArray<const char*>* path_array = new GrowableArray<const char*>(10);
702 ClassPathEntry* cpe = ClassLoader::app_classpath_entries();
703 while (cpe != nullptr) {
704 path_array->append(cpe->name());
705 cpe = cpe->next();
706 }
707 return path_array;
708 }
709
710 GrowableArray<const char*>* FileMapInfo::create_path_array(const char* paths) {
711 GrowableArray<const char*>* path_array = new GrowableArray<const char*>(10);
712 JavaThread* current = JavaThread::current();
713 ClasspathStream cp_stream(paths);
714 bool non_jar_in_cp = header()->has_non_jar_in_classpath();
715 while (cp_stream.has_next()) {
716 const char* path = cp_stream.get_next();
717 if (!non_jar_in_cp) {
718 struct stat st;
719 if (os::stat(path, &st) == 0) {
720 path_array->append(path);
721 }
722 } else {
723 const char* canonical_path = ClassLoader::get_canonical_path(path, current);
724 if (canonical_path != nullptr) {
725 char* error_msg = nullptr;
726 jzfile* zip = ClassLoader::open_zip_file(canonical_path, &error_msg, current);
727 if (zip != nullptr && error_msg == nullptr) {
728 path_array->append(path);
729 }
730 }
731 }
732 }
733 return path_array;
734 }
735
736 bool FileMapInfo::classpath_failure(const char* msg, const char* name) {
737 ClassLoader::trace_class_path(msg, name);
738 if (PrintSharedArchiveAndExit) {
739 MetaspaceShared::set_archive_loading_failed();
740 }
741 return false;
742 }
743
744 unsigned int FileMapInfo::longest_common_app_classpath_prefix_len(int num_paths,
745 GrowableArray<const char*>* rp_array) {
746 if (num_paths == 0) {
747 return 0;
748 }
749 unsigned int pos;
750 for (pos = 0; ; pos++) {
751 for (int i = 0; i < num_paths; i++) {
752 if (rp_array->at(i)[pos] != '\0' && rp_array->at(i)[pos] == rp_array->at(0)[pos]) {
753 continue;
754 }
755 // search backward for the pos before the file separator char
756 while (pos > 0) {
757 if (rp_array->at(0)[--pos] == *os::file_separator()) {
758 return pos + 1;
759 }
760 }
761 return 0;
762 }
763 }
764 return 0;
765 }
766
767 bool FileMapInfo::check_paths(int shared_path_start_idx, int num_paths, GrowableArray<const char*>* rp_array,
768 unsigned int dumptime_prefix_len, unsigned int runtime_prefix_len) {
769 int i = 0;
770 int j = shared_path_start_idx;
771 while (i < num_paths) {
772 while (shared_path(j)->from_class_path_attr()) {
773 // shared_path(j) was expanded from the JAR file attribute "Class-Path:"
774 // during dump time. It's not included in the -classpath VM argument.
775 j++;
776 }
777 assert(strlen(shared_path(j)->name()) > (size_t)dumptime_prefix_len, "sanity");
778 const char* dumptime_path = shared_path(j)->name() + dumptime_prefix_len;
779 assert(strlen(rp_array->at(i)) > (size_t)runtime_prefix_len, "sanity");
780 const char* runtime_path = rp_array->at(i) + runtime_prefix_len;
781 if (!os::same_files(dumptime_path, runtime_path)) {
782 return false;
783 }
784 i++;
785 j++;
786 }
787 return true;
788 }
789
790 bool FileMapInfo::validate_boot_class_paths() {
791 //
792 // - Archive contains boot classes only - relaxed boot path check:
793 // Extra path elements appended to the boot path at runtime are allowed.
794 //
795 // - Archive contains application or platform classes - strict boot path check:
796 // Validate the entire runtime boot path, which must be compatible
797 // with the dump time boot path. Appending boot path at runtime is not
798 // allowed.
799 //
800
801 // The first entry in boot path is the modules_image (guaranteed by
802 // ClassLoader::setup_boot_search_path()). Skip the first entry. The
803 // path of the runtime modules_image may be different from the dump
804 // time path (e.g. the JDK image is copied to a different location
805 // after generating the shared archive), which is acceptable. For most
806 // common cases, the dump time boot path might contain modules_image only.
807 char* runtime_boot_path = Arguments::get_boot_class_path();
808 char* rp = skip_first_path_entry(runtime_boot_path);
809 assert(shared_path(0)->is_modules_image(), "first shared_path must be the modules image");
810 int dp_len = header()->app_class_paths_start_index() - 1; // ignore the first path to the module image
811 bool match = true;
812
813 bool relaxed_check = !header()->has_platform_or_app_classes();
814 if (dp_len == 0 && rp == nullptr) {
815 return true; // ok, both runtime and dump time boot paths have modules_images only
816 } else if (dp_len == 0 && rp != nullptr) {
817 if (relaxed_check) {
818 return true; // ok, relaxed check, runtime has extra boot append path entries
819 } else {
820 ResourceMark rm;
821 if (check_paths_existence(rp)) {
822 // If a path exists in the runtime boot paths, it is considered a mismatch
823 // since there's no boot path specified during dump time.
824 match = false;
825 }
826 }
827 } else if (dp_len > 0 && rp != nullptr) {
828 int num;
829 ResourceMark rm;
830 GrowableArray<const char*>* rp_array = create_path_array(rp);
831 int rp_len = rp_array->length();
832 if (rp_len >= dp_len) {
833 if (relaxed_check) {
834 // only check the leading entries in the runtime boot path, up to
835 // the length of the dump time boot path
836 num = dp_len;
837 } else {
838 // check the full runtime boot path, must match with dump time
839 num = rp_len;
840 }
841 match = check_paths(1, num, rp_array, 0, 0);
842 } else {
843 // create_path_array() ignores non-existing paths. Although the dump time and runtime boot classpath lengths
844 // are the same initially, after the call to create_path_array(), the runtime boot classpath length could become
845 // shorter. We consider boot classpath mismatch in this case.
846 match = false;
847 }
848 }
849
850 if (!match) {
851 // The paths are different
852 return classpath_failure("[BOOT classpath mismatch, actual =", runtime_boot_path);
853 }
854 return true;
855 }
856
857 bool FileMapInfo::validate_app_class_paths(int shared_app_paths_len) {
858 const char *appcp = Arguments::get_appclasspath();
859 assert(appcp != nullptr, "null app classpath");
860 int rp_len = num_paths(appcp);
861 bool match = false;
862 if (rp_len < shared_app_paths_len) {
863 return classpath_failure("Run time APP classpath is shorter than the one at dump time: ", appcp);
864 }
865 if (shared_app_paths_len != 0 && rp_len != 0) {
866 // Prefix is OK: E.g., dump with -cp foo.jar, but run with -cp foo.jar:bar.jar.
867 ResourceMark rm;
868 GrowableArray<const char*>* rp_array = create_path_array(appcp);
869 if (rp_array->length() == 0) {
870 // None of the jar file specified in the runtime -cp exists.
871 return classpath_failure("None of the jar file specified in the runtime -cp exists: -Djava.class.path=", appcp);
872 }
873 if (rp_array->length() < shared_app_paths_len) {
874 // create_path_array() ignores non-existing paths. Although the dump time and runtime app classpath lengths
875 // are the same initially, after the call to create_path_array(), the runtime app classpath length could become
876 // shorter. We consider app classpath mismatch in this case.
877 return classpath_failure("[APP classpath mismatch, actual: -Djava.class.path=", appcp);
878 }
879
880 // Handling of non-existent entries in the classpath: we eliminate all the non-existent
881 // entries from both the dump time classpath (ClassLoader::update_class_path_entry_list)
882 // and the runtime classpath (FileMapInfo::create_path_array), and check the remaining
883 // entries. E.g.:
884 //
885 // dump : -cp a.jar:NE1:NE2:b.jar -> a.jar:b.jar -> recorded in archive.
886 // run 1: -cp NE3:a.jar:NE4:b.jar -> a.jar:b.jar -> matched
887 // run 2: -cp x.jar:NE4:b.jar -> x.jar:b.jar -> mismatched
888
889 int j = header()->app_class_paths_start_index();
890 match = check_paths(j, shared_app_paths_len, rp_array, 0, 0);
891 if (!match) {
892 // To facilitate app deployment, we allow the JAR files to be moved *together* to
893 // a different location, as long as they are still stored under the same directory
894 // structure. E.g., the following is OK.
895 // java -Xshare:dump -cp /a/Foo.jar:/a/b/Bar.jar ...
896 // java -Xshare:auto -cp /x/y/Foo.jar:/x/y/b/Bar.jar ...
897 unsigned int dumptime_prefix_len = header()->common_app_classpath_prefix_size();
898 unsigned int runtime_prefix_len = longest_common_app_classpath_prefix_len(shared_app_paths_len, rp_array);
899 if (dumptime_prefix_len != 0 || runtime_prefix_len != 0) {
900 log_info(class, path)("LCP length for app classpath (dumptime: %u, runtime: %u)",
901 dumptime_prefix_len, runtime_prefix_len);
902 match = check_paths(j, shared_app_paths_len, rp_array,
903 dumptime_prefix_len, runtime_prefix_len);
904 }
905 if (!match) {
906 return classpath_failure("[APP classpath mismatch, actual: -Djava.class.path=", appcp);
907 }
908 }
909 }
910 return true;
911 }
912
913 void FileMapInfo::log_paths(const char* msg, int start_idx, int end_idx) {
914 LogTarget(Info, class, path) lt;
915 if (lt.is_enabled()) {
916 LogStream ls(lt);
917 ls.print("%s", msg);
918 const char* prefix = "";
919 for (int i = start_idx; i < end_idx; i++) {
920 ls.print("%s%s", prefix, shared_path(i)->name());
921 prefix = os::path_separator();
922 }
923 ls.cr();
924 }
925 }
926
927 void FileMapInfo::extract_module_paths(const char* runtime_path, GrowableArray<const char*>* module_paths) {
928 GrowableArray<const char*>* path_array = create_path_array(runtime_path);
929 int num_paths = path_array->length();
930 for (int i = 0; i < num_paths; i++) {
931 const char* name = path_array->at(i);
932 ClassLoaderExt::extract_jar_files_from_path(name, module_paths);
933 }
934 // module paths are stored in sorted order in the CDS archive.
935 module_paths->sort(ClassLoaderExt::compare_module_names);
936 }
937
938 bool FileMapInfo::check_module_paths() {
939 const char* runtime_path = Arguments::get_property("jdk.module.path");
940 int archived_num_module_paths = header()->num_module_paths();
941 if (runtime_path == nullptr && archived_num_module_paths == 0) {
942 return true;
943 }
944 if ((runtime_path == nullptr && archived_num_module_paths > 0) ||
945 (runtime_path != nullptr && archived_num_module_paths == 0)) {
946 return false;
947 }
948 ResourceMark rm;
949 GrowableArray<const char*>* module_paths = new GrowableArray<const char*>(3);
950 extract_module_paths(runtime_path, module_paths);
951 int num_paths = module_paths->length();
952 if (num_paths != archived_num_module_paths) {
953 return false;
954 }
955 return check_paths(header()->app_module_paths_start_index(), num_paths, module_paths, 0, 0);
956 }
957
958 bool FileMapInfo::validate_shared_path_table() {
959 assert(CDSConfig::is_using_archive(), "runtime only");
960
961 _validating_shared_path_table = true;
962
963 // Load the shared path table info from the archive header
964 _shared_path_table = header()->shared_path_table();
965
966 bool matched_module_paths = true;
967 if (CDSConfig::is_dumping_dynamic_archive() || header()->has_full_module_graph()) {
968 matched_module_paths = check_module_paths();
969 }
970 if (header()->has_full_module_graph() && !matched_module_paths) {
971 CDSConfig::stop_using_optimized_module_handling();
972 log_info(cds)("optimized module handling: disabled because of mismatched module paths");
973 }
974
975 if (CDSConfig::is_dumping_dynamic_archive()) {
976 // Only support dynamic dumping with the usage of the default CDS archive
977 // or a simple base archive.
978 // If the base layer archive contains additional path component besides
979 // the runtime image and the -cp, dynamic dumping is disabled.
980 //
981 // When dynamic archiving is enabled, the _shared_path_table is overwritten
982 // to include the application path and stored in the top layer archive.
983 assert(shared_path(0)->is_modules_image(), "first shared_path must be the modules image");
984 if (header()->app_class_paths_start_index() > 1) {
985 CDSConfig::disable_dumping_dynamic_archive();
986 log_warning(cds)(
987 "Dynamic archiving is disabled because base layer archive has appended boot classpath");
988 }
989 if (header()->num_module_paths() > 0) {
990 if (!matched_module_paths) {
991 CDSConfig::disable_dumping_dynamic_archive();
992 log_warning(cds)(
993 "Dynamic archiving is disabled because base layer archive has a different module path");
994 }
995 }
996 }
997
998 log_paths("Expecting BOOT path=", 0, header()->app_class_paths_start_index());
999 log_paths("Expecting -Djava.class.path=", header()->app_class_paths_start_index(), header()->app_module_paths_start_index());
1000
1001 int module_paths_start_index = header()->app_module_paths_start_index();
1002 int shared_app_paths_len = 0;
1003
1004 // validate the path entries up to the _max_used_path_index
1005 for (int i=0; i < header()->max_used_path_index() + 1; i++) {
1006 if (i < module_paths_start_index) {
1007 if (shared_path(i)->validate()) {
1008 // Only count the app class paths not from the "Class-path" attribute of a jar manifest.
1009 if (!shared_path(i)->from_class_path_attr() && i >= header()->app_class_paths_start_index()) {
1010 shared_app_paths_len++;
1011 }
1012 log_info(class, path)("ok");
1013 } else {
1014 if (_dynamic_archive_info != nullptr && _dynamic_archive_info->_is_static) {
1015 assert(!CDSConfig::is_using_archive(), "UseSharedSpaces should be disabled");
1016 }
1017 return false;
1018 }
1019 } else if (i >= module_paths_start_index) {
1020 if (shared_path(i)->validate(false /* not a class path entry */)) {
1021 log_info(class, path)("ok");
1022 } else {
1023 if (_dynamic_archive_info != nullptr && _dynamic_archive_info->_is_static) {
1024 assert(!CDSConfig::is_using_archive(), "UseSharedSpaces should be disabled");
1025 }
1026 return false;
1027 }
1028 }
1029 }
1030
1031 if (header()->max_used_path_index() == 0) {
1032 // default archive only contains the module image in the bootclasspath
1033 assert(shared_path(0)->is_modules_image(), "first shared_path must be the modules image");
1034 } else {
1035 if (!validate_boot_class_paths() || !validate_app_class_paths(shared_app_paths_len)) {
1036 const char* mismatch_msg = "shared class paths mismatch";
1037 const char* hint_msg = log_is_enabled(Info, class, path) ?
1038 "" : " (hint: enable -Xlog:class+path=info to diagnose the failure)";
1039 if (RequireSharedSpaces) {
1040 log_error(cds)("%s%s", mismatch_msg, hint_msg);
1041 MetaspaceShared::unrecoverable_loading_error();
1042 } else {
1043 log_warning(cds)("%s%s", mismatch_msg, hint_msg);
1044 }
1045 return false;
1046 }
1047 }
1048
1049 validate_non_existent_class_paths();
1050
1051 _validating_shared_path_table = false;
1052
1053 #if INCLUDE_JVMTI
1054 if (_classpath_entries_for_jvmti != nullptr) {
1055 os::free(_classpath_entries_for_jvmti);
1056 }
1057 size_t sz = sizeof(ClassPathEntry*) * get_number_of_shared_paths();
1058 _classpath_entries_for_jvmti = (ClassPathEntry**)os::malloc(sz, mtClass);
1059 memset((void*)_classpath_entries_for_jvmti, 0, sz);
1060 #endif
1061
1062 return true;
1063 }
1064
1065 void FileMapInfo::validate_non_existent_class_paths() {
1066 // All of the recorded non-existent paths came from the Class-Path: attribute from the JAR
1067 // files on the app classpath. If any of these are found to exist during runtime,
1068 // it will change how classes are loading for the app loader. For safety, disable
1069 // loading of archived platform/app classes (currently there's no way to disable just the
1070 // app classes).
1071
1072 assert(CDSConfig::is_using_archive(), "runtime only");
1073 for (int i = header()->app_module_paths_start_index() + header()->num_module_paths();
1074 i < get_number_of_shared_paths();
1075 i++) {
1076 SharedClassPathEntry* ent = shared_path(i);
1077 if (!ent->check_non_existent()) {
1078 log_warning(cds)("Archived non-system classes are disabled because the "
1079 "file %s exists", ent->name());
1080 header()->set_has_platform_or_app_classes(false);
1081 }
1082 }
1083 }
1084
1085 // A utility class for reading/validating the GenericCDSFileMapHeader portion of
1086 // a CDS archive's header. The file header of all CDS archives with versions from
1087 // CDS_GENERIC_HEADER_SUPPORTED_MIN_VERSION (12) are guaranteed to always start
1088 // with GenericCDSFileMapHeader. This makes it possible to read important information
1089 // from a CDS archive created by a different version of HotSpot, so that we can
1090 // automatically regenerate the archive as necessary (JDK-8261455).
1091 class FileHeaderHelper {
1092 int _fd;
1093 bool _is_valid;
1094 bool _is_static;
1095 GenericCDSFileMapHeader* _header;
1096 const char* _archive_name;
1097 const char* _base_archive_name;
1098
1099 public:
1100 FileHeaderHelper(const char* archive_name, bool is_static) {
1101 _fd = -1;
1102 _is_valid = false;
1103 _header = nullptr;
1104 _base_archive_name = nullptr;
1105 _archive_name = archive_name;
1106 _is_static = is_static;
1107 }
1108
1109 ~FileHeaderHelper() {
1110 if (_header != nullptr) {
1111 FREE_C_HEAP_ARRAY(char, _header);
1112 }
1113 if (_fd != -1) {
1114 ::close(_fd);
1115 }
1116 }
1117
1118 bool initialize() {
1119 assert(_archive_name != nullptr, "Archive name is null");
1120 _fd = os::open(_archive_name, O_RDONLY | O_BINARY, 0);
1121 if (_fd < 0) {
1122 log_info(cds)("Specified shared archive not found (%s)", _archive_name);
1123 return false;
1124 }
1125 return initialize(_fd);
1126 }
1127
1128 // for an already opened file, do not set _fd
1129 bool initialize(int fd) {
1130 assert(_archive_name != nullptr, "Archive name is null");
1131 assert(fd != -1, "Archive must be opened already");
1132 // First read the generic header so we know the exact size of the actual header.
1133 GenericCDSFileMapHeader gen_header;
1134 size_t size = sizeof(GenericCDSFileMapHeader);
1135 os::lseek(fd, 0, SEEK_SET);
1136 size_t n = ::read(fd, (void*)&gen_header, (unsigned int)size);
1137 if (n != size) {
1138 log_warning(cds)("Unable to read generic CDS file map header from shared archive");
1139 return false;
1140 }
1141
1142 if (gen_header._magic != CDS_ARCHIVE_MAGIC &&
1143 gen_header._magic != CDS_DYNAMIC_ARCHIVE_MAGIC) {
1144 log_warning(cds)("The shared archive file has a bad magic number: %#x", gen_header._magic);
1145 return false;
1146 }
1147
1148 if (gen_header._version < CDS_GENERIC_HEADER_SUPPORTED_MIN_VERSION) {
1149 log_warning(cds)("Cannot handle shared archive file version 0x%x. Must be at least 0x%x.",
1150 gen_header._version, CDS_GENERIC_HEADER_SUPPORTED_MIN_VERSION);
1151 return false;
1152 }
1153
1154 if (gen_header._version != CURRENT_CDS_ARCHIVE_VERSION) {
1155 log_warning(cds)("The shared archive file version 0x%x does not match the required version 0x%x.",
1156 gen_header._version, CURRENT_CDS_ARCHIVE_VERSION);
1157 }
1158
1159 size_t filelen = os::lseek(fd, 0, SEEK_END);
1160 if (gen_header._header_size >= filelen) {
1161 log_warning(cds)("Archive file header larger than archive file");
1162 return false;
1163 }
1164
1165 // Read the actual header and perform more checks
1166 size = gen_header._header_size;
1167 _header = (GenericCDSFileMapHeader*)NEW_C_HEAP_ARRAY(char, size, mtInternal);
1168 os::lseek(fd, 0, SEEK_SET);
1169 n = ::read(fd, (void*)_header, (unsigned int)size);
1170 if (n != size) {
1171 log_warning(cds)("Unable to read actual CDS file map header from shared archive");
1172 return false;
1173 }
1174
1175 if (!check_header_crc()) {
1176 return false;
1177 }
1178
1179 if (!check_and_init_base_archive_name()) {
1180 return false;
1181 }
1182
1183 // All fields in the GenericCDSFileMapHeader has been validated.
1184 _is_valid = true;
1185 return true;
1186 }
1187
1188 GenericCDSFileMapHeader* get_generic_file_header() {
1189 assert(_header != nullptr && _is_valid, "must be a valid archive file");
1190 return _header;
1191 }
1192
1193 const char* base_archive_name() {
1194 assert(_header != nullptr && _is_valid, "must be a valid archive file");
1195 return _base_archive_name;
1196 }
1197
1198 private:
1199 bool check_header_crc() const {
1200 if (VerifySharedSpaces) {
1201 FileMapHeader* header = (FileMapHeader*)_header;
1202 int actual_crc = header->compute_crc();
1203 if (actual_crc != header->crc()) {
1204 log_info(cds)("_crc expected: %d", header->crc());
1205 log_info(cds)(" actual: %d", actual_crc);
1206 log_warning(cds)("Header checksum verification failed.");
1207 return false;
1208 }
1209 }
1210 return true;
1211 }
1212
1213 bool check_and_init_base_archive_name() {
1214 unsigned int name_offset = _header->_base_archive_name_offset;
1215 unsigned int name_size = _header->_base_archive_name_size;
1216 unsigned int header_size = _header->_header_size;
1217
1218 if (name_offset + name_size < name_offset) {
1219 log_warning(cds)("base_archive_name offset/size overflow: " UINT32_FORMAT "/" UINT32_FORMAT,
1220 name_offset, name_size);
1221 return false;
1222 }
1223 if (_header->_magic == CDS_ARCHIVE_MAGIC) {
1224 if (name_offset != 0) {
1225 log_warning(cds)("static shared archive must have zero _base_archive_name_offset");
1226 return false;
1227 }
1228 if (name_size != 0) {
1229 log_warning(cds)("static shared archive must have zero _base_archive_name_size");
1230 return false;
1231 }
1232 } else {
1233 assert(_header->_magic == CDS_DYNAMIC_ARCHIVE_MAGIC, "must be");
1234 if ((name_size == 0 && name_offset != 0) ||
1235 (name_size != 0 && name_offset == 0)) {
1236 // If either is zero, both must be zero. This indicates that we are using the default base archive.
1237 log_warning(cds)("Invalid base_archive_name offset/size: " UINT32_FORMAT "/" UINT32_FORMAT,
1238 name_offset, name_size);
1239 return false;
1240 }
1241 if (name_size > 0) {
1242 if (name_offset + name_size > header_size) {
1243 log_warning(cds)("Invalid base_archive_name offset/size (out of range): "
1244 UINT32_FORMAT " + " UINT32_FORMAT " > " UINT32_FORMAT ,
1245 name_offset, name_size, header_size);
1246 return false;
1247 }
1248 const char* name = ((const char*)_header) + _header->_base_archive_name_offset;
1249 if (name[name_size - 1] != '\0' || strlen(name) != name_size - 1) {
1250 log_warning(cds)("Base archive name is damaged");
1251 return false;
1252 }
1253 if (!os::file_exists(name)) {
1254 log_warning(cds)("Base archive %s does not exist", name);
1255 return false;
1256 }
1257 _base_archive_name = name;
1258 }
1259 }
1260
1261 return true;
1262 }
1263 };
1264
1265 // Return value:
1266 // false:
1267 // <archive_name> is not a valid archive. *base_archive_name is set to null.
1268 // true && (*base_archive_name) == nullptr:
1269 // <archive_name> is a valid static archive.
1270 // true && (*base_archive_name) != nullptr:
1271 // <archive_name> is a valid dynamic archive.
1272 bool FileMapInfo::get_base_archive_name_from_header(const char* archive_name,
1273 char** base_archive_name) {
1274 FileHeaderHelper file_helper(archive_name, false);
1275 *base_archive_name = nullptr;
1276
1277 if (!file_helper.initialize()) {
1278 return false;
1279 }
1280 GenericCDSFileMapHeader* header = file_helper.get_generic_file_header();
1281 if (header->_magic != CDS_DYNAMIC_ARCHIVE_MAGIC) {
1282 assert(header->_magic == CDS_ARCHIVE_MAGIC, "must be");
1283 if (AutoCreateSharedArchive) {
1284 log_warning(cds)("AutoCreateSharedArchive is ignored because %s is a static archive", archive_name);
1285 }
1286 return true;
1287 }
1288
1289 const char* base = file_helper.base_archive_name();
1290 if (base == nullptr) {
1291 *base_archive_name = CDSConfig::default_archive_path();
1292 } else {
1293 *base_archive_name = os::strdup_check_oom(base);
1294 }
1295
1296 return true;
1297 }
1298
1299 // Read the FileMapInfo information from the file.
1300
1301 bool FileMapInfo::init_from_file(int fd) {
1302 FileHeaderHelper file_helper(_full_path, _is_static);
1303 if (!file_helper.initialize(fd)) {
1304 log_warning(cds)("Unable to read the file header.");
1305 return false;
1306 }
1307 GenericCDSFileMapHeader* gen_header = file_helper.get_generic_file_header();
1308
1309 if (_is_static) {
1310 if (gen_header->_magic != CDS_ARCHIVE_MAGIC) {
1311 log_warning(cds)("Not a base shared archive: %s", _full_path);
1312 return false;
1313 }
1314 } else {
1315 if (gen_header->_magic != CDS_DYNAMIC_ARCHIVE_MAGIC) {
1316 log_warning(cds)("Not a top shared archive: %s", _full_path);
1317 return false;
1318 }
1319 }
1320
1321 _header = (FileMapHeader*)os::malloc(gen_header->_header_size, mtInternal);
1322 os::lseek(fd, 0, SEEK_SET); // reset to begin of the archive
1323 size_t size = gen_header->_header_size;
1324 size_t n = ::read(fd, (void*)_header, (unsigned int)size);
1325 if (n != size) {
1326 log_warning(cds)("Failed to read file header from the top archive file\n");
1327 return false;
1328 }
1329
1330 if (header()->version() != CURRENT_CDS_ARCHIVE_VERSION) {
1331 log_info(cds)("_version expected: 0x%x", CURRENT_CDS_ARCHIVE_VERSION);
1332 log_info(cds)(" actual: 0x%x", header()->version());
1333 log_warning(cds)("The shared archive file has the wrong version.");
1334 return false;
1335 }
1336
1337 int common_path_size = header()->common_app_classpath_prefix_size();
1338 if (common_path_size < 0) {
1339 log_warning(cds)("common app classpath prefix len < 0");
1340 return false;
1341 }
1342
1343 unsigned int base_offset = header()->base_archive_name_offset();
1344 unsigned int name_size = header()->base_archive_name_size();
1345 unsigned int header_size = header()->header_size();
1346 if (base_offset != 0 && name_size != 0) {
1347 if (header_size != base_offset + name_size) {
1348 log_info(cds)("_header_size: " UINT32_FORMAT, header_size);
1349 log_info(cds)("common_app_classpath_size: " UINT32_FORMAT, header()->common_app_classpath_prefix_size());
1350 log_info(cds)("base_archive_name_size: " UINT32_FORMAT, header()->base_archive_name_size());
1351 log_info(cds)("base_archive_name_offset: " UINT32_FORMAT, header()->base_archive_name_offset());
1352 log_warning(cds)("The shared archive file has an incorrect header size.");
1353 return false;
1354 }
1355 }
1356
1357 const char* actual_ident = header()->jvm_ident();
1358
1359 if (actual_ident[JVM_IDENT_MAX-1] != 0) {
1360 log_warning(cds)("JVM version identifier is corrupted.");
1361 return false;
1362 }
1363
1364 char expected_ident[JVM_IDENT_MAX];
1365 get_header_version(expected_ident);
1366 if (strncmp(actual_ident, expected_ident, JVM_IDENT_MAX-1) != 0) {
1367 log_info(cds)("_jvm_ident expected: %s", expected_ident);
1368 log_info(cds)(" actual: %s", actual_ident);
1369 log_warning(cds)("The shared archive file was created by a different"
1370 " version or build of HotSpot");
1371 return false;
1372 }
1373
1374 _file_offset = header()->header_size(); // accounts for the size of _base_archive_name
1375
1376 size_t len = os::lseek(fd, 0, SEEK_END);
1377
1378 for (int i = 0; i < MetaspaceShared::n_regions; i++) {
1379 FileMapRegion* r = region_at(i);
1380 if (r->file_offset() > len || len - r->file_offset() < r->used()) {
1381 log_warning(cds)("The shared archive file has been truncated.");
1382 return false;
1383 }
1384 }
1385
1386 return true;
1387 }
1388
1389 void FileMapInfo::seek_to_position(size_t pos) {
1390 if (os::lseek(_fd, (long)pos, SEEK_SET) < 0) {
1391 log_error(cds)("Unable to seek to position " SIZE_FORMAT, pos);
1392 MetaspaceShared::unrecoverable_loading_error();
1393 }
1394 }
1395
1396 // Read the FileMapInfo information from the file.
1397 bool FileMapInfo::open_for_read() {
1398 if (_file_open) {
1399 return true;
1400 }
1401 log_info(cds)("trying to map %s", _full_path);
1402 int fd = os::open(_full_path, O_RDONLY | O_BINARY, 0);
1403 if (fd < 0) {
1404 if (errno == ENOENT) {
1405 log_info(cds)("Specified shared archive not found (%s)", _full_path);
1406 } else {
1407 log_warning(cds)("Failed to open shared archive file (%s)",
1408 os::strerror(errno));
1409 }
1410 return false;
1411 } else {
1412 log_info(cds)("Opened archive %s.", _full_path);
1413 }
1414
1415 _fd = fd;
1416 _file_open = true;
1417 return true;
1418 }
1419
1420 // Write the FileMapInfo information to the file.
1421
1422 void FileMapInfo::open_for_write() {
1423 LogMessage(cds) msg;
1424 if (msg.is_info()) {
1425 msg.info("Dumping shared data to file: ");
1426 msg.info(" %s", _full_path);
1427 }
1428
1429 #ifdef _WINDOWS // On Windows, need WRITE permission to remove the file.
1430 chmod(_full_path, _S_IREAD | _S_IWRITE);
1431 #endif
1432
1433 // Use remove() to delete the existing file because, on Unix, this will
1434 // allow processes that have it open continued access to the file.
1435 remove(_full_path);
1436 int fd = os::open(_full_path, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0444);
1437 if (fd < 0) {
1438 log_error(cds)("Unable to create shared archive file %s: (%s).", _full_path,
1439 os::strerror(errno));
1440 MetaspaceShared::writing_error();
1441 return;
1442 }
1443 _fd = fd;
1444 _file_open = true;
1445
1446 // Seek past the header. We will write the header after all regions are written
1447 // and their CRCs computed.
1448 size_t header_bytes = header()->header_size();
1449
1450 header_bytes = align_up(header_bytes, MetaspaceShared::core_region_alignment());
1451 _file_offset = header_bytes;
1452 seek_to_position(_file_offset);
1453 }
1454
1455 // Write the header to the file, seek to the next allocation boundary.
1456
1457 void FileMapInfo::write_header() {
1458 _file_offset = 0;
1459 seek_to_position(_file_offset);
1460 assert(is_file_position_aligned(), "must be");
1461 write_bytes(header(), header()->header_size());
1462 }
1463
1464 size_t FileMapRegion::used_aligned() const {
1465 return align_up(used(), MetaspaceShared::core_region_alignment());
1466 }
1467
1468 void FileMapRegion::init(int region_index, size_t mapping_offset, size_t size, bool read_only,
1469 bool allow_exec, int crc) {
1470 _is_heap_region = HeapShared::is_heap_region(region_index);
1471 _is_bitmap_region = (region_index == MetaspaceShared::bm);
1472 _mapping_offset = mapping_offset;
1473 _used = size;
1474 _read_only = read_only;
1475 _allow_exec = allow_exec;
1476 _crc = crc;
1477 _mapped_from_file = false;
1478 _mapped_base = nullptr;
1479 }
1480
1481 void FileMapRegion::init_oopmap(size_t offset, size_t size_in_bits) {
1482 _oopmap_offset = offset;
1483 _oopmap_size_in_bits = size_in_bits;
1484 }
1485
1486 void FileMapRegion::init_ptrmap(size_t offset, size_t size_in_bits) {
1487 _ptrmap_offset = offset;
1488 _ptrmap_size_in_bits = size_in_bits;
1489 }
1490
1491 bool FileMapRegion::check_region_crc(char* base) const {
1492 // This function should be called after the region has been properly
1493 // loaded into memory via FileMapInfo::map_region() or FileMapInfo::read_region().
1494 // I.e., this->mapped_base() must be valid.
1495 size_t sz = used();
1496 if (sz == 0) {
1497 return true;
1498 }
1499
1500 assert(base != nullptr, "must be initialized");
1501 int crc = ClassLoader::crc32(0, base, (jint)sz);
1502 if (crc != this->crc()) {
1503 log_warning(cds)("Checksum verification failed.");
1504 return false;
1505 }
1506 return true;
1507 }
1508
1509 static const char* region_name(int region_index) {
1510 static const char* names[] = {
1511 "rw", "ro", "bm", "hp"
1512 };
1513 const int num_regions = sizeof(names)/sizeof(names[0]);
1514 assert(0 <= region_index && region_index < num_regions, "sanity");
1515
1516 return names[region_index];
1517 }
1518
1519 BitMapView FileMapInfo::bitmap_view(int region_index, bool is_oopmap) {
1520 FileMapRegion* r = region_at(region_index);
1521 char* bitmap_base = is_static() ? FileMapInfo::current_info()->map_bitmap_region() : FileMapInfo::dynamic_info()->map_bitmap_region();
1522 bitmap_base += is_oopmap ? r->oopmap_offset() : r->ptrmap_offset();
1523 size_t size_in_bits = is_oopmap ? r->oopmap_size_in_bits() : r->ptrmap_size_in_bits();
1524
1525 log_debug(cds, reloc)("mapped %s relocation %smap @ " INTPTR_FORMAT " (" SIZE_FORMAT " bits)",
1526 region_name(region_index), is_oopmap ? "oop" : "ptr",
1527 p2i(bitmap_base), size_in_bits);
1528
1529 return BitMapView((BitMap::bm_word_t*)(bitmap_base), size_in_bits);
1530 }
1531
1532 BitMapView FileMapInfo::oopmap_view(int region_index) {
1533 return bitmap_view(region_index, /*is_oopmap*/true);
1534 }
1535
1536 BitMapView FileMapInfo::ptrmap_view(int region_index) {
1537 return bitmap_view(region_index, /*is_oopmap*/false);
1538 }
1539
1540 void FileMapRegion::print(outputStream* st, int region_index) {
1541 st->print_cr("============ region ============= %d \"%s\"", region_index, region_name(region_index));
1542 st->print_cr("- crc: 0x%08x", _crc);
1543 st->print_cr("- read_only: %d", _read_only);
1544 st->print_cr("- allow_exec: %d", _allow_exec);
1545 st->print_cr("- is_heap_region: %d", _is_heap_region);
1546 st->print_cr("- is_bitmap_region: %d", _is_bitmap_region);
1547 st->print_cr("- mapped_from_file: %d", _mapped_from_file);
1548 st->print_cr("- file_offset: " SIZE_FORMAT_X, _file_offset);
1549 st->print_cr("- mapping_offset: " SIZE_FORMAT_X, _mapping_offset);
1550 st->print_cr("- used: " SIZE_FORMAT, _used);
1551 st->print_cr("- oopmap_offset: " SIZE_FORMAT_X, _oopmap_offset);
1552 st->print_cr("- oopmap_size_in_bits: " SIZE_FORMAT, _oopmap_size_in_bits);
1553 st->print_cr("- ptrmap_offset: " SIZE_FORMAT_X, _ptrmap_offset);
1554 st->print_cr("- ptrmap_size_in_bits: " SIZE_FORMAT, _ptrmap_size_in_bits);
1555 st->print_cr("- mapped_base: " INTPTR_FORMAT, p2i(_mapped_base));
1556 }
1557
1558 void FileMapInfo::write_region(int region, char* base, size_t size,
1559 bool read_only, bool allow_exec) {
1560 assert(CDSConfig::is_dumping_archive(), "sanity");
1561
1562 FileMapRegion* r = region_at(region);
1563 char* requested_base;
1564 size_t mapping_offset = 0;
1565
1566 if (region == MetaspaceShared::bm) {
1567 requested_base = nullptr; // always null for bm region
1568 } else if (size == 0) {
1569 // This is an unused region (e.g., a heap region when !INCLUDE_CDS_JAVA_HEAP)
1570 requested_base = nullptr;
1571 } else if (HeapShared::is_heap_region(region)) {
1572 assert(HeapShared::can_write(), "sanity");
1573 #if INCLUDE_CDS_JAVA_HEAP
1574 assert(!CDSConfig::is_dumping_dynamic_archive(), "must be");
1575 requested_base = (char*)ArchiveHeapWriter::requested_address();
1576 if (UseCompressedOops) {
1577 mapping_offset = (size_t)((address)requested_base - CompressedOops::base());
1578 assert((mapping_offset >> CompressedOops::shift()) << CompressedOops::shift() == mapping_offset, "must be");
1579 } else {
1580 mapping_offset = 0; // not used with !UseCompressedOops
1581 }
1582 #endif // INCLUDE_CDS_JAVA_HEAP
1583 } else {
1584 char* requested_SharedBaseAddress = (char*)MetaspaceShared::requested_base_address();
1585 requested_base = ArchiveBuilder::current()->to_requested(base);
1586 assert(requested_base >= requested_SharedBaseAddress, "must be");
1587 mapping_offset = requested_base - requested_SharedBaseAddress;
1588 }
1589
1590 r->set_file_offset(_file_offset);
1591 int crc = ClassLoader::crc32(0, base, (jint)size);
1592 if (size > 0) {
1593 log_info(cds)("Shared file region (%s) %d: " SIZE_FORMAT_W(8)
1594 " bytes, addr " INTPTR_FORMAT " file offset 0x%08" PRIxPTR
1595 " crc 0x%08x",
1596 region_name(region), region, size, p2i(requested_base), _file_offset, crc);
1597 }
1598
1599 r->init(region, mapping_offset, size, read_only, allow_exec, crc);
1600
1601 if (base != nullptr) {
1602 write_bytes_aligned(base, size);
1603 }
1604 }
1605
1606 static size_t write_bitmap(const CHeapBitMap* map, char* output, size_t offset) {
1607 size_t size_in_bytes = map->size_in_bytes();
1608 map->write_to((BitMap::bm_word_t*)(output + offset), size_in_bytes);
1609 return offset + size_in_bytes;
1610 }
1611
1612 // The sorting code groups the objects with non-null oop/ptrs together.
1613 // Relevant bitmaps then have lots of leading and trailing zeros, which
1614 // we do not have to store.
1615 size_t FileMapInfo::remove_bitmap_zeros(CHeapBitMap* map) {
1616 BitMap::idx_t first_set = map->find_first_set_bit(0);
1617 BitMap::idx_t last_set = map->find_last_set_bit(0);
1618 size_t old_size = map->size();
1619
1620 // Slice and resize bitmap
1621 map->truncate(first_set, last_set + 1);
1622
1623 assert(map->at(0), "First bit should be set");
1624 assert(map->at(map->size() - 1), "Last bit should be set");
1625 assert(map->size() <= old_size, "sanity");
1626
1627 return first_set;
1628 }
1629
1630 char* FileMapInfo::write_bitmap_region(CHeapBitMap* rw_ptrmap, CHeapBitMap* ro_ptrmap, ArchiveHeapInfo* heap_info,
1631 size_t &size_in_bytes) {
1632 size_t removed_rw_leading_zeros = remove_bitmap_zeros(rw_ptrmap);
1633 size_t removed_ro_leading_zeros = remove_bitmap_zeros(ro_ptrmap);
1634 header()->set_rw_ptrmap_start_pos(removed_rw_leading_zeros);
1635 header()->set_ro_ptrmap_start_pos(removed_ro_leading_zeros);
1636 size_in_bytes = rw_ptrmap->size_in_bytes() + ro_ptrmap->size_in_bytes();
1637
1638 if (heap_info->is_used()) {
1639 // Remove leading and trailing zeros
1640 size_t removed_oop_leading_zeros = remove_bitmap_zeros(heap_info->oopmap());
1641 size_t removed_ptr_leading_zeros = remove_bitmap_zeros(heap_info->ptrmap());
1642 header()->set_heap_oopmap_start_pos(removed_oop_leading_zeros);
1643 header()->set_heap_ptrmap_start_pos(removed_ptr_leading_zeros);
1644
1645 size_in_bytes += heap_info->oopmap()->size_in_bytes();
1646 size_in_bytes += heap_info->ptrmap()->size_in_bytes();
1647 }
1648
1649 // The bitmap region contains up to 4 parts:
1650 // rw_ptrmap: metaspace pointers inside the read-write region
1651 // ro_ptrmap: metaspace pointers inside the read-only region
1652 // heap_info->oopmap(): Java oop pointers in the heap region
1653 // heap_info->ptrmap(): metaspace pointers in the heap region
1654 char* buffer = NEW_C_HEAP_ARRAY(char, size_in_bytes, mtClassShared);
1655 size_t written = 0;
1656
1657 region_at(MetaspaceShared::rw)->init_ptrmap(0, rw_ptrmap->size());
1658 written = write_bitmap(rw_ptrmap, buffer, written);
1659
1660 region_at(MetaspaceShared::ro)->init_ptrmap(written, ro_ptrmap->size());
1661 written = write_bitmap(ro_ptrmap, buffer, written);
1662
1663 if (heap_info->is_used()) {
1664 FileMapRegion* r = region_at(MetaspaceShared::hp);
1665
1666 r->init_oopmap(written, heap_info->oopmap()->size());
1667 written = write_bitmap(heap_info->oopmap(), buffer, written);
1668
1669 r->init_ptrmap(written, heap_info->ptrmap()->size());
1670 written = write_bitmap(heap_info->ptrmap(), buffer, written);
1671 }
1672
1673 write_region(MetaspaceShared::bm, (char*)buffer, size_in_bytes, /*read_only=*/true, /*allow_exec=*/false);
1674 return buffer;
1675 }
1676
1677 size_t FileMapInfo::write_heap_region(ArchiveHeapInfo* heap_info) {
1678 char* buffer_start = heap_info->buffer_start();
1679 size_t buffer_size = heap_info->buffer_byte_size();
1680 write_region(MetaspaceShared::hp, buffer_start, buffer_size, false, false);
1681 header()->set_heap_root_segments(heap_info->heap_root_segments());
1682 return buffer_size;
1683 }
1684
1685 // Dump bytes to file -- at the current file position.
1686
1687 void FileMapInfo::write_bytes(const void* buffer, size_t nbytes) {
1688 assert(_file_open, "must be");
1689 if (!os::write(_fd, buffer, nbytes)) {
1690 // If the shared archive is corrupted, close it and remove it.
1691 close();
1692 remove(_full_path);
1693 MetaspaceShared::writing_error("Unable to write to shared archive file.");
1694 }
1695 _file_offset += nbytes;
1696 }
1697
1698 bool FileMapInfo::is_file_position_aligned() const {
1699 return _file_offset == align_up(_file_offset,
1700 MetaspaceShared::core_region_alignment());
1701 }
1702
1703 // Align file position to an allocation unit boundary.
1704
1705 void FileMapInfo::align_file_position() {
1706 assert(_file_open, "must be");
1707 size_t new_file_offset = align_up(_file_offset,
1708 MetaspaceShared::core_region_alignment());
1709 if (new_file_offset != _file_offset) {
1710 _file_offset = new_file_offset;
1711 // Seek one byte back from the target and write a byte to insure
1712 // that the written file is the correct length.
1713 _file_offset -= 1;
1714 seek_to_position(_file_offset);
1715 char zero = 0;
1716 write_bytes(&zero, 1);
1717 }
1718 }
1719
1720
1721 // Dump bytes to file -- at the current file position.
1722
1723 void FileMapInfo::write_bytes_aligned(const void* buffer, size_t nbytes) {
1724 align_file_position();
1725 write_bytes(buffer, nbytes);
1726 align_file_position();
1727 }
1728
1729 // Close the shared archive file. This does NOT unmap mapped regions.
1730
1731 void FileMapInfo::close() {
1732 if (_file_open) {
1733 if (::close(_fd) < 0) {
1734 MetaspaceShared::unrecoverable_loading_error("Unable to close the shared archive file.");
1735 }
1736 _file_open = false;
1737 _fd = -1;
1738 }
1739 }
1740
1741 /*
1742 * Same as os::map_memory() but also pretouches if AlwaysPreTouch is enabled.
1743 */
1744 static char* map_memory(int fd, const char* file_name, size_t file_offset,
1745 char *addr, size_t bytes, bool read_only,
1746 bool allow_exec, MemTag mem_tag = mtNone) {
1747 char* mem = os::map_memory(fd, file_name, file_offset, addr, bytes,
1748 AlwaysPreTouch ? false : read_only,
1749 allow_exec, mem_tag);
1750 if (mem != nullptr && AlwaysPreTouch) {
1751 os::pretouch_memory(mem, mem + bytes);
1752 }
1753 return mem;
1754 }
1755
1756 // JVM/TI RedefineClasses() support:
1757 // Remap the shared readonly space to shared readwrite, private.
1758 bool FileMapInfo::remap_shared_readonly_as_readwrite() {
1759 int idx = MetaspaceShared::ro;
1760 FileMapRegion* r = region_at(idx);
1761 if (!r->read_only()) {
1762 // the space is already readwrite so we are done
1763 return true;
1764 }
1765 size_t size = r->used_aligned();
1766 if (!open_for_read()) {
1767 return false;
1768 }
1769 char *addr = r->mapped_base();
1770 // This path should not be reached for Windows; see JDK-8222379.
1771 assert(WINDOWS_ONLY(false) NOT_WINDOWS(true), "Don't call on Windows");
1772 // Replace old mapping with new one that is writable.
1773 char *base = os::map_memory(_fd, _full_path, r->file_offset(),
1774 addr, size, false /* !read_only */,
1775 r->allow_exec());
1776 close();
1777 // These have to be errors because the shared region is now unmapped.
1778 if (base == nullptr) {
1779 log_error(cds)("Unable to remap shared readonly space (errno=%d).", errno);
1780 vm_exit(1);
1781 }
1782 if (base != addr) {
1783 log_error(cds)("Unable to remap shared readonly space (errno=%d).", errno);
1784 vm_exit(1);
1785 }
1786 r->set_read_only(false);
1787 return true;
1788 }
1789
1790 // Memory map a region in the address space.
1791 static const char* shared_region_name[] = { "ReadWrite", "ReadOnly", "Bitmap", "Heap" };
1792
1793 MapArchiveResult FileMapInfo::map_regions(int regions[], int num_regions, char* mapped_base_address, ReservedSpace rs) {
1794 DEBUG_ONLY(FileMapRegion* last_region = nullptr);
1795 intx addr_delta = mapped_base_address - header()->requested_base_address();
1796
1797 // Make sure we don't attempt to use header()->mapped_base_address() unless
1798 // it's been successfully mapped.
1799 DEBUG_ONLY(header()->set_mapped_base_address((char*)(uintptr_t)0xdeadbeef);)
1800
1801 for (int i = 0; i < num_regions; i++) {
1802 int idx = regions[i];
1803 MapArchiveResult result = map_region(idx, addr_delta, mapped_base_address, rs);
1804 if (result != MAP_ARCHIVE_SUCCESS) {
1805 return result;
1806 }
1807 FileMapRegion* r = region_at(idx);
1808 DEBUG_ONLY(if (last_region != nullptr) {
1809 // Ensure that the OS won't be able to allocate new memory spaces between any mapped
1810 // regions, or else it would mess up the simple comparison in MetaspaceObj::is_shared().
1811 assert(r->mapped_base() == last_region->mapped_end(), "must have no gaps");
1812 }
1813 last_region = r;)
1814 log_info(cds)("Mapped %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)", is_static() ? "static " : "dynamic",
1815 idx, p2i(r->mapped_base()), p2i(r->mapped_end()),
1816 shared_region_name[idx]);
1817
1818 }
1819
1820 header()->set_mapped_base_address(header()->requested_base_address() + addr_delta);
1821 if (addr_delta != 0 && !relocate_pointers_in_core_regions(addr_delta)) {
1822 return MAP_ARCHIVE_OTHER_FAILURE;
1823 }
1824
1825 return MAP_ARCHIVE_SUCCESS;
1826 }
1827
1828 bool FileMapInfo::read_region(int i, char* base, size_t size, bool do_commit) {
1829 FileMapRegion* r = region_at(i);
1830 if (do_commit) {
1831 log_info(cds)("Commit %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)%s",
1832 is_static() ? "static " : "dynamic", i, p2i(base), p2i(base + size),
1833 shared_region_name[i], r->allow_exec() ? " exec" : "");
1834 if (!os::commit_memory(base, size, r->allow_exec())) {
1835 log_error(cds)("Failed to commit %s region #%d (%s)", is_static() ? "static " : "dynamic",
1836 i, shared_region_name[i]);
1837 return false;
1838 }
1839 }
1840 if (os::lseek(_fd, (long)r->file_offset(), SEEK_SET) != (int)r->file_offset() ||
1841 read_bytes(base, size) != size) {
1842 return false;
1843 }
1844
1845 if (VerifySharedSpaces && !r->check_region_crc(base)) {
1846 return false;
1847 }
1848
1849 r->set_mapped_from_file(false);
1850 r->set_mapped_base(base);
1851
1852 return true;
1853 }
1854
1855 MapArchiveResult FileMapInfo::map_region(int i, intx addr_delta, char* mapped_base_address, ReservedSpace rs) {
1856 assert(!HeapShared::is_heap_region(i), "sanity");
1857 FileMapRegion* r = region_at(i);
1858 size_t size = r->used_aligned();
1859 char *requested_addr = mapped_base_address + r->mapping_offset();
1860 assert(r->mapped_base() == nullptr, "must be not mapped yet");
1861 assert(requested_addr != nullptr, "must be specified");
1862
1863 r->set_mapped_from_file(false);
1864
1865 if (MetaspaceShared::use_windows_memory_mapping()) {
1866 // Windows cannot remap read-only shared memory to read-write when required for
1867 // RedefineClasses, which is also used by JFR. Always map windows regions as RW.
1868 r->set_read_only(false);
1869 } else if (JvmtiExport::can_modify_any_class() || JvmtiExport::can_walk_any_space() ||
1870 Arguments::has_jfr_option()) {
1871 // If a tool agent is in use (debugging enabled), or JFR, we must map the address space RW
1872 r->set_read_only(false);
1873 } else if (addr_delta != 0) {
1874 r->set_read_only(false); // Need to patch the pointers
1875 }
1876
1877 if (MetaspaceShared::use_windows_memory_mapping() && rs.is_reserved()) {
1878 // This is the second time we try to map the archive(s). We have already created a ReservedSpace
1879 // that covers all the FileMapRegions to ensure all regions can be mapped. However, Windows
1880 // can't mmap into a ReservedSpace, so we just ::read() the data. We're going to patch all the
1881 // regions anyway, so there's no benefit for mmap anyway.
1882 if (!read_region(i, requested_addr, size, /* do_commit = */ true)) {
1883 log_info(cds)("Failed to read %s shared space into reserved space at " INTPTR_FORMAT,
1884 shared_region_name[i], p2i(requested_addr));
1885 return MAP_ARCHIVE_OTHER_FAILURE; // oom or I/O error.
1886 } else {
1887 assert(r->mapped_base() != nullptr, "must be initialized");
1888 return MAP_ARCHIVE_SUCCESS;
1889 }
1890 } else {
1891 // Note that this may either be a "fresh" mapping into unreserved address
1892 // space (Windows, first mapping attempt), or a mapping into pre-reserved
1893 // space (Posix). See also comment in MetaspaceShared::map_archives().
1894 char* base = map_memory(_fd, _full_path, r->file_offset(),
1895 requested_addr, size, r->read_only(),
1896 r->allow_exec(), mtClassShared);
1897 if (base != requested_addr) {
1898 log_info(cds)("Unable to map %s shared space at " INTPTR_FORMAT,
1899 shared_region_name[i], p2i(requested_addr));
1900 _memory_mapping_failed = true;
1901 return MAP_ARCHIVE_MMAP_FAILURE;
1902 }
1903
1904 if (VerifySharedSpaces && !r->check_region_crc(requested_addr)) {
1905 return MAP_ARCHIVE_OTHER_FAILURE;
1906 }
1907
1908 r->set_mapped_from_file(true);
1909 r->set_mapped_base(requested_addr);
1910
1911 return MAP_ARCHIVE_SUCCESS;
1912 }
1913 }
1914
1915 // The return value is the location of the archive relocation bitmap.
1916 char* FileMapInfo::map_bitmap_region() {
1917 FileMapRegion* r = region_at(MetaspaceShared::bm);
1918 if (r->mapped_base() != nullptr) {
1919 return r->mapped_base();
1920 }
1921 bool read_only = true, allow_exec = false;
1922 char* requested_addr = nullptr; // allow OS to pick any location
1923 char* bitmap_base = map_memory(_fd, _full_path, r->file_offset(),
1924 requested_addr, r->used_aligned(), read_only, allow_exec, mtClassShared);
1925 if (bitmap_base == nullptr) {
1926 log_info(cds)("failed to map relocation bitmap");
1927 return nullptr;
1928 }
1929
1930 if (VerifySharedSpaces && !r->check_region_crc(bitmap_base)) {
1931 log_error(cds)("relocation bitmap CRC error");
1932 if (!os::unmap_memory(bitmap_base, r->used_aligned())) {
1933 fatal("os::unmap_memory of relocation bitmap failed");
1934 }
1935 return nullptr;
1936 }
1937
1938 r->set_mapped_from_file(true);
1939 r->set_mapped_base(bitmap_base);
1940 log_info(cds)("Mapped %s region #%d at base " INTPTR_FORMAT " top " INTPTR_FORMAT " (%s)",
1941 is_static() ? "static " : "dynamic",
1942 MetaspaceShared::bm, p2i(r->mapped_base()), p2i(r->mapped_end()),
1943 shared_region_name[MetaspaceShared::bm]);
1944 return bitmap_base;
1945 }
1946
1947 // This is called when we cannot map the archive at the requested[ base address (usually 0x800000000).
1948 // We relocate all pointers in the 2 core regions (ro, rw).
1949 bool FileMapInfo::relocate_pointers_in_core_regions(intx addr_delta) {
1950 log_debug(cds, reloc)("runtime archive relocation start");
1951 char* bitmap_base = map_bitmap_region();
1952
1953 if (bitmap_base == nullptr) {
1954 return false; // OOM, or CRC check failure
1955 } else {
1956 BitMapView rw_ptrmap = ptrmap_view(MetaspaceShared::rw);
1957 BitMapView ro_ptrmap = ptrmap_view(MetaspaceShared::ro);
1958
1959 FileMapRegion* rw_region = first_core_region();
1960 FileMapRegion* ro_region = last_core_region();
1961
1962 // Patch all pointers inside the RW region
1963 address rw_patch_base = (address)rw_region->mapped_base();
1964 address rw_patch_end = (address)rw_region->mapped_end();
1965
1966 // Patch all pointers inside the RO region
1967 address ro_patch_base = (address)ro_region->mapped_base();
1968 address ro_patch_end = (address)ro_region->mapped_end();
1969
1970 // the current value of the pointers to be patched must be within this
1971 // range (i.e., must be between the requested base address and the address of the current archive).
1972 // Note: top archive may point to objects in the base archive, but not the other way around.
1973 address valid_old_base = (address)header()->requested_base_address();
1974 address valid_old_end = valid_old_base + mapping_end_offset();
1975
1976 // after patching, the pointers must point inside this range
1977 // (the requested location of the archive, as mapped at runtime).
1978 address valid_new_base = (address)header()->mapped_base_address();
1979 address valid_new_end = (address)mapped_end();
1980
1981 SharedDataRelocator rw_patcher((address*)rw_patch_base + header()->rw_ptrmap_start_pos(), (address*)rw_patch_end, valid_old_base, valid_old_end,
1982 valid_new_base, valid_new_end, addr_delta);
1983 SharedDataRelocator ro_patcher((address*)ro_patch_base + header()->ro_ptrmap_start_pos(), (address*)ro_patch_end, valid_old_base, valid_old_end,
1984 valid_new_base, valid_new_end, addr_delta);
1985 rw_ptrmap.iterate(&rw_patcher);
1986 ro_ptrmap.iterate(&ro_patcher);
1987
1988 // The MetaspaceShared::bm region will be unmapped in MetaspaceShared::initialize_shared_spaces().
1989
1990 log_debug(cds, reloc)("runtime archive relocation done");
1991 return true;
1992 }
1993 }
1994
1995 size_t FileMapInfo::read_bytes(void* buffer, size_t count) {
1996 assert(_file_open, "Archive file is not open");
1997 size_t n = ::read(_fd, buffer, (unsigned int)count);
1998 if (n != count) {
1999 // Close the file if there's a problem reading it.
2000 close();
2001 return 0;
2002 }
2003 _file_offset += count;
2004 return count;
2005 }
2006
2007 // Get the total size in bytes of a read only region
2008 size_t FileMapInfo::readonly_total() {
2009 size_t total = 0;
2010 if (current_info() != nullptr) {
2011 FileMapRegion* r = FileMapInfo::current_info()->region_at(MetaspaceShared::ro);
2012 if (r->read_only()) total += r->used();
2013 }
2014 if (dynamic_info() != nullptr) {
2015 FileMapRegion* r = FileMapInfo::dynamic_info()->region_at(MetaspaceShared::ro);
2016 if (r->read_only()) total += r->used();
2017 }
2018 return total;
2019 }
2020
2021 #if INCLUDE_CDS_JAVA_HEAP
2022 MemRegion FileMapInfo::_mapped_heap_memregion;
2023
2024 bool FileMapInfo::has_heap_region() {
2025 return (region_at(MetaspaceShared::hp)->used() > 0);
2026 }
2027
2028 // Returns the address range of the archived heap region computed using the
2029 // current oop encoding mode. This range may be different than the one seen at
2030 // dump time due to encoding mode differences. The result is used in determining
2031 // if/how these regions should be relocated at run time.
2032 MemRegion FileMapInfo::get_heap_region_requested_range() {
2033 FileMapRegion* r = region_at(MetaspaceShared::hp);
2034 size_t size = r->used();
2035 assert(size > 0, "must have non-empty heap region");
2036
2037 address start = heap_region_requested_address();
2038 address end = start + size;
2039 log_info(cds)("Requested heap region [" INTPTR_FORMAT " - " INTPTR_FORMAT "] = " SIZE_FORMAT_W(8) " bytes",
2040 p2i(start), p2i(end), size);
2041
2042 return MemRegion((HeapWord*)start, (HeapWord*)end);
2043 }
2044
2045 void FileMapInfo::map_or_load_heap_region() {
2046 bool success = false;
2047
2048 if (can_use_heap_region()) {
2049 if (ArchiveHeapLoader::can_map()) {
2050 success = map_heap_region();
2051 } else if (ArchiveHeapLoader::can_load()) {
2052 success = ArchiveHeapLoader::load_heap_region(this);
2053 } else {
2054 if (!UseCompressedOops && !ArchiveHeapLoader::can_map()) {
2055 log_info(cds)("Cannot use CDS heap data. Selected GC not compatible -XX:-UseCompressedOops");
2056 } else {
2057 log_info(cds)("Cannot use CDS heap data. UseEpsilonGC, UseG1GC, UseSerialGC, UseParallelGC, or UseShenandoahGC are required.");
2058 }
2059 }
2060 }
2061
2062 if (!success) {
2063 CDSConfig::stop_using_full_module_graph();
2064 }
2065 }
2066
2067 bool FileMapInfo::can_use_heap_region() {
2068 if (!has_heap_region()) {
2069 return false;
2070 }
2071 if (JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()) {
2072 ShouldNotReachHere(); // CDS should have been disabled.
2073 // The archived objects are mapped at JVM start-up, but we don't know if
2074 // j.l.String or j.l.Class might be replaced by the ClassFileLoadHook,
2075 // which would make the archived String or mirror objects invalid. Let's be safe and not
2076 // use the archived objects. These 2 classes are loaded during the JVMTI "early" stage.
2077 //
2078 // If JvmtiExport::has_early_class_hook_env() is false, the classes of some objects
2079 // in the archived subgraphs may be replaced by the ClassFileLoadHook. But that's OK
2080 // because we won't install an archived object subgraph if the klass of any of the
2081 // referenced objects are replaced. See HeapShared::initialize_from_archived_subgraph().
2082 }
2083
2084 // We pre-compute narrow Klass IDs with the runtime mapping start intended to be the base, and a shift of
2085 // ArchiveHeapWriter::precomputed_narrow_klass_shift. We enforce this encoding at runtime (see
2086 // CompressedKlassPointers::initialize_for_given_encoding()). Therefore, the following assertions must
2087 // hold:
2088 address archive_narrow_klass_base = (address)header()->mapped_base_address();
2089 const int archive_narrow_klass_shift = ArchiveHeapWriter::precomputed_narrow_klass_shift;
2090
2091 log_info(cds)("CDS archive was created with max heap size = " SIZE_FORMAT "M, and the following configuration:",
2092 max_heap_size()/M);
2093 log_info(cds)(" narrow_klass_base at mapping start address, narrow_klass_shift = %d",
2094 archive_narrow_klass_shift);
2095 log_info(cds)(" narrow_oop_mode = %d, narrow_oop_base = " PTR_FORMAT ", narrow_oop_shift = %d",
2096 narrow_oop_mode(), p2i(narrow_oop_base()), narrow_oop_shift());
2097 log_info(cds)("The current max heap size = " SIZE_FORMAT "M, G1HeapRegion::GrainBytes = " SIZE_FORMAT,
2098 MaxHeapSize/M, G1HeapRegion::GrainBytes);
2099 log_info(cds)(" narrow_klass_base = " PTR_FORMAT ", narrow_klass_shift = %d",
2100 p2i(CompressedKlassPointers::base()), CompressedKlassPointers::shift());
2101 log_info(cds)(" narrow_oop_mode = %d, narrow_oop_base = " PTR_FORMAT ", narrow_oop_shift = %d",
2102 CompressedOops::mode(), p2i(CompressedOops::base()), CompressedOops::shift());
2103 log_info(cds)(" heap range = [" PTR_FORMAT " - " PTR_FORMAT "]",
2104 UseCompressedOops ? p2i(CompressedOops::begin()) :
2105 UseG1GC ? p2i((address)G1CollectedHeap::heap()->reserved().start()) : 0L,
2106 UseCompressedOops ? p2i(CompressedOops::end()) :
2107 UseG1GC ? p2i((address)G1CollectedHeap::heap()->reserved().end()) : 0L);
2108
2109 assert(archive_narrow_klass_base == CompressedKlassPointers::base(), "Unexpected encoding base encountered "
2110 "(" PTR_FORMAT ", expected " PTR_FORMAT ")", p2i(CompressedKlassPointers::base()), p2i(archive_narrow_klass_base));
2111 assert(archive_narrow_klass_shift == CompressedKlassPointers::shift(), "Unexpected encoding shift encountered "
2112 "(%d, expected %d)", CompressedKlassPointers::shift(), archive_narrow_klass_shift);
2113
2114 return true;
2115 }
2116
2117 // The actual address of this region during dump time.
2118 address FileMapInfo::heap_region_dumptime_address() {
2119 FileMapRegion* r = region_at(MetaspaceShared::hp);
2120 assert(CDSConfig::is_using_archive(), "runtime only");
2121 assert(is_aligned(r->mapping_offset(), sizeof(HeapWord)), "must be");
2122 if (UseCompressedOops) {
2123 return /*dumptime*/ narrow_oop_base() + r->mapping_offset();
2124 } else {
2125 return heap_region_requested_address();
2126 }
2127 }
2128
2129 // The address where this region can be mapped into the runtime heap without
2130 // patching any of the pointers that are embedded in this region.
2131 address FileMapInfo::heap_region_requested_address() {
2132 assert(CDSConfig::is_using_archive(), "runtime only");
2133 FileMapRegion* r = region_at(MetaspaceShared::hp);
2134 assert(is_aligned(r->mapping_offset(), sizeof(HeapWord)), "must be");
2135 assert(ArchiveHeapLoader::can_use(), "GC must support mapping or loading");
2136 if (UseCompressedOops) {
2137 // We can avoid relocation if each region's offset from the runtime CompressedOops::base()
2138 // is the same as its offset from the CompressedOops::base() during dumptime.
2139 // Note that CompressedOops::base() may be different between dumptime and runtime.
2140 //
2141 // Example:
2142 // Dumptime base = 0x1000 and shift is 0. We have a region at address 0x2000. There's a
2143 // narrowOop P stored in this region that points to an object at address 0x2200.
2144 // P's encoded value is 0x1200.
2145 //
2146 // Runtime base = 0x4000 and shift is also 0. If we map this region at 0x5000, then
2147 // the value P can remain 0x1200. The decoded address = (0x4000 + (0x1200 << 0)) = 0x5200,
2148 // which is the runtime location of the referenced object.
2149 return /*runtime*/ CompressedOops::base() + r->mapping_offset();
2150 } else {
2151 // This was the hard-coded requested base address used at dump time. With uncompressed oops,
2152 // the heap range is assigned by the OS so we will most likely have to relocate anyway, no matter
2153 // what base address was picked at duump time.
2154 return (address)ArchiveHeapWriter::NOCOOPS_REQUESTED_BASE;
2155 }
2156 }
2157
2158 bool FileMapInfo::map_heap_region() {
2159 if (map_heap_region_impl()) {
2160 #ifdef ASSERT
2161 // The "old" regions must be parsable -- we cannot have any unused space
2162 // at the start of the lowest G1 region that contains archived objects.
2163 assert(is_aligned(_mapped_heap_memregion.start(), G1HeapRegion::GrainBytes), "must be");
2164
2165 // Make sure we map at the very top of the heap - see comments in
2166 // init_heap_region_relocation().
2167 MemRegion heap_range = G1CollectedHeap::heap()->reserved();
2168 assert(heap_range.contains(_mapped_heap_memregion), "must be");
2169
2170 address heap_end = (address)heap_range.end();
2171 address mapped_heap_region_end = (address)_mapped_heap_memregion.end();
2172 assert(heap_end >= mapped_heap_region_end, "must be");
2173 assert(heap_end - mapped_heap_region_end < (intx)(G1HeapRegion::GrainBytes),
2174 "must be at the top of the heap to avoid fragmentation");
2175 #endif
2176
2177 ArchiveHeapLoader::set_mapped();
2178 return true;
2179 } else {
2180 return false;
2181 }
2182 }
2183
2184 bool FileMapInfo::map_heap_region_impl() {
2185 assert(UseG1GC, "the following code assumes G1");
2186
2187 FileMapRegion* r = region_at(MetaspaceShared::hp);
2188 size_t size = r->used();
2189 if (size == 0) {
2190 return false; // no archived java heap data
2191 }
2192
2193 size_t word_size = size / HeapWordSize;
2194 address requested_start = heap_region_requested_address();
2195
2196 log_info(cds)("Preferred address to map heap data (to avoid relocation) is " INTPTR_FORMAT, p2i(requested_start));
2197
2198 // allocate from java heap
2199 HeapWord* start = G1CollectedHeap::heap()->alloc_archive_region(word_size, (HeapWord*)requested_start);
2200 if (start == nullptr) {
2201 log_info(cds)("UseSharedSpaces: Unable to allocate java heap region for archive heap.");
2202 return false;
2203 }
2204
2205 _mapped_heap_memregion = MemRegion(start, word_size);
2206
2207 // Map the archived heap data. No need to call MemTracker::record_virtual_memory_tag()
2208 // for mapped region as it is part of the reserved java heap, which is already recorded.
2209 char* addr = (char*)_mapped_heap_memregion.start();
2210 char* base;
2211
2212 if (MetaspaceShared::use_windows_memory_mapping()) {
2213 if (!read_region(MetaspaceShared::hp, addr,
2214 align_up(_mapped_heap_memregion.byte_size(), os::vm_page_size()),
2215 /* do_commit = */ true)) {
2216 dealloc_heap_region();
2217 log_error(cds)("Failed to read archived heap region into " INTPTR_FORMAT, p2i(addr));
2218 return false;
2219 }
2220 // Checks for VerifySharedSpaces is already done inside read_region()
2221 base = addr;
2222 } else {
2223 base = map_memory(_fd, _full_path, r->file_offset(),
2224 addr, _mapped_heap_memregion.byte_size(), r->read_only(),
2225 r->allow_exec());
2226 if (base == nullptr || base != addr) {
2227 dealloc_heap_region();
2228 log_info(cds)("UseSharedSpaces: Unable to map at required address in java heap. "
2229 INTPTR_FORMAT ", size = " SIZE_FORMAT " bytes",
2230 p2i(addr), _mapped_heap_memregion.byte_size());
2231 return false;
2232 }
2233
2234 if (VerifySharedSpaces && !r->check_region_crc(base)) {
2235 dealloc_heap_region();
2236 log_info(cds)("UseSharedSpaces: mapped heap region is corrupt");
2237 return false;
2238 }
2239 }
2240
2241 r->set_mapped_base(base);
2242
2243 // If the requested range is different from the range allocated by GC, then
2244 // the pointers need to be patched.
2245 address mapped_start = (address) _mapped_heap_memregion.start();
2246 ptrdiff_t delta = mapped_start - requested_start;
2247 if (UseCompressedOops &&
2248 (narrow_oop_mode() != CompressedOops::mode() ||
2249 narrow_oop_shift() != CompressedOops::shift())) {
2250 _heap_pointers_need_patching = true;
2251 }
2252 if (delta != 0) {
2253 _heap_pointers_need_patching = true;
2254 }
2255 ArchiveHeapLoader::init_mapped_heap_info(mapped_start, delta, narrow_oop_shift());
2256
2257 if (_heap_pointers_need_patching) {
2258 char* bitmap_base = map_bitmap_region();
2259 if (bitmap_base == nullptr) {
2260 log_info(cds)("CDS heap cannot be used because bitmap region cannot be mapped");
2261 dealloc_heap_region();
2262 unmap_region(MetaspaceShared::hp);
2263 _heap_pointers_need_patching = false;
2264 return false;
2265 }
2266 }
2267 log_info(cds)("Heap data mapped at " INTPTR_FORMAT ", size = " SIZE_FORMAT_W(8) " bytes",
2268 p2i(mapped_start), _mapped_heap_memregion.byte_size());
2269 log_info(cds)("CDS heap data relocation delta = " INTX_FORMAT " bytes", delta);
2270 return true;
2271 }
2272
2273 narrowOop FileMapInfo::encoded_heap_region_dumptime_address() {
2274 assert(CDSConfig::is_using_archive(), "runtime only");
2275 assert(UseCompressedOops, "sanity");
2276 FileMapRegion* r = region_at(MetaspaceShared::hp);
2277 return CompressedOops::narrow_oop_cast(r->mapping_offset() >> narrow_oop_shift());
2278 }
2279
2280 void FileMapInfo::patch_heap_embedded_pointers() {
2281 if (!ArchiveHeapLoader::is_mapped() || !_heap_pointers_need_patching) {
2282 return;
2283 }
2284
2285 char* bitmap_base = map_bitmap_region();
2286 assert(bitmap_base != nullptr, "must have already been mapped");
2287
2288 FileMapRegion* r = region_at(MetaspaceShared::hp);
2289 ArchiveHeapLoader::patch_embedded_pointers(
2290 this, _mapped_heap_memregion,
2291 (address)(region_at(MetaspaceShared::bm)->mapped_base()) + r->oopmap_offset(),
2292 r->oopmap_size_in_bits());
2293 }
2294
2295 void FileMapInfo::fixup_mapped_heap_region() {
2296 if (ArchiveHeapLoader::is_mapped()) {
2297 assert(!_mapped_heap_memregion.is_empty(), "sanity");
2298
2299 // Populate the archive regions' G1BlockOffsetTables. That ensures
2300 // fast G1BlockOffsetTable::block_start operations for any given address
2301 // within the archive regions when trying to find start of an object
2302 // (e.g. during card table scanning).
2303 G1CollectedHeap::heap()->populate_archive_regions_bot(_mapped_heap_memregion);
2304 }
2305 }
2306
2307 // dealloc the archive regions from java heap
2308 void FileMapInfo::dealloc_heap_region() {
2309 G1CollectedHeap::heap()->dealloc_archive_regions(_mapped_heap_memregion);
2310 }
2311 #endif // INCLUDE_CDS_JAVA_HEAP
2312
2313 void FileMapInfo::unmap_regions(int regions[], int num_regions) {
2314 for (int r = 0; r < num_regions; r++) {
2315 int idx = regions[r];
2316 unmap_region(idx);
2317 }
2318 }
2319
2320 // Unmap a memory region in the address space.
2321
2322 void FileMapInfo::unmap_region(int i) {
2323 FileMapRegion* r = region_at(i);
2324 char* mapped_base = r->mapped_base();
2325 size_t size = r->used_aligned();
2326
2327 if (mapped_base != nullptr) {
2328 if (size > 0 && r->mapped_from_file()) {
2329 log_info(cds)("Unmapping region #%d at base " INTPTR_FORMAT " (%s)", i, p2i(mapped_base),
2330 shared_region_name[i]);
2331 if (!os::unmap_memory(mapped_base, size)) {
2332 fatal("os::unmap_memory failed");
2333 }
2334 }
2335 r->set_mapped_base(nullptr);
2336 }
2337 }
2338
2339 void FileMapInfo::assert_mark(bool check) {
2340 if (!check) {
2341 MetaspaceShared::unrecoverable_loading_error("Mark mismatch while restoring from shared file.");
2342 }
2343 }
2344
2345 FileMapInfo* FileMapInfo::_current_info = nullptr;
2346 FileMapInfo* FileMapInfo::_dynamic_archive_info = nullptr;
2347 bool FileMapInfo::_heap_pointers_need_patching = false;
2348 SharedPathTable FileMapInfo::_shared_path_table;
2349 bool FileMapInfo::_validating_shared_path_table = false;
2350 bool FileMapInfo::_memory_mapping_failed = false;
2351 GrowableArray<const char*>* FileMapInfo::_non_existent_class_paths = nullptr;
2352
2353 // Open the shared archive file, read and validate the header
2354 // information (version, boot classpath, etc.). If initialization
2355 // fails, shared spaces are disabled and the file is closed.
2356 //
2357 // Validation of the archive is done in two steps:
2358 //
2359 // [1] validate_header() - done here.
2360 // [2] validate_shared_path_table - this is done later, because the table is in the RW
2361 // region of the archive, which is not mapped yet.
2362 bool FileMapInfo::initialize() {
2363 assert(CDSConfig::is_using_archive(), "UseSharedSpaces expected.");
2364 assert(Arguments::has_jimage(), "The shared archive file cannot be used with an exploded module build.");
2365
2366 if (JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()) {
2367 // CDS assumes that no classes resolved in vmClasses::resolve_all()
2368 // are replaced at runtime by JVMTI ClassFileLoadHook. All of those classes are resolved
2369 // during the JVMTI "early" stage, so we can still use CDS if
2370 // JvmtiExport::has_early_class_hook_env() is false.
2371 log_info(cds)("CDS is disabled because early JVMTI ClassFileLoadHook is in use.");
2372 return false;
2373 }
2374
2375 if (!open_for_read() || !init_from_file(_fd) || !validate_header()) {
2376 if (_is_static) {
2377 log_info(cds)("Initialize static archive failed.");
2378 return false;
2379 } else {
2380 log_info(cds)("Initialize dynamic archive failed.");
2381 if (AutoCreateSharedArchive) {
2382 CDSConfig::enable_dumping_dynamic_archive();
2383 ArchiveClassesAtExit = CDSConfig::dynamic_archive_path();
2384 }
2385 return false;
2386 }
2387 }
2388
2389 return true;
2390 }
2391
2392 // The 2 core spaces are RW->RO
2393 FileMapRegion* FileMapInfo::first_core_region() const {
2394 return region_at(MetaspaceShared::rw);
2395 }
2396
2397 FileMapRegion* FileMapInfo::last_core_region() const {
2398 return region_at(MetaspaceShared::ro);
2399 }
2400
2401 void FileMapInfo::print(outputStream* st) const {
2402 header()->print(st);
2403 if (!is_static()) {
2404 dynamic_header()->print(st);
2405 }
2406 }
2407
2408 void FileMapHeader::set_as_offset(char* p, size_t *offset) {
2409 *offset = ArchiveBuilder::current()->any_to_offset((address)p);
2410 }
2411
2412 int FileMapHeader::compute_crc() {
2413 char* start = (char*)this;
2414 // start computing from the field after _header_size to end of base archive name.
2415 char* buf = (char*)&(_generic_header._header_size) + sizeof(_generic_header._header_size);
2416 size_t sz = header_size() - (buf - start);
2417 int crc = ClassLoader::crc32(0, buf, (jint)sz);
2418 return crc;
2419 }
2420
2421 // This function should only be called during run time with UseSharedSpaces enabled.
2422 bool FileMapHeader::validate() {
2423 if (_obj_alignment != ObjectAlignmentInBytes) {
2424 log_info(cds)("The shared archive file's ObjectAlignmentInBytes of %d"
2425 " does not equal the current ObjectAlignmentInBytes of %d.",
2426 _obj_alignment, ObjectAlignmentInBytes);
2427 return false;
2428 }
2429 if (_compact_strings != CompactStrings) {
2430 log_info(cds)("The shared archive file's CompactStrings setting (%s)"
2431 " does not equal the current CompactStrings setting (%s).",
2432 _compact_strings ? "enabled" : "disabled",
2433 CompactStrings ? "enabled" : "disabled");
2434 return false;
2435 }
2436
2437 // This must be done after header validation because it might change the
2438 // header data
2439 const char* prop = Arguments::get_property("java.system.class.loader");
2440 if (prop != nullptr) {
2441 log_warning(cds)("Archived non-system classes are disabled because the "
2442 "java.system.class.loader property is specified (value = \"%s\"). "
2443 "To use archived non-system classes, this property must not be set", prop);
2444 _has_platform_or_app_classes = false;
2445 }
2446
2447
2448 if (!_verify_local && BytecodeVerificationLocal) {
2449 // we cannot load boot classes, so there's no point of using the CDS archive
2450 log_info(cds)("The shared archive file's BytecodeVerificationLocal setting (%s)"
2451 " does not equal the current BytecodeVerificationLocal setting (%s).",
2452 _verify_local ? "enabled" : "disabled",
2453 BytecodeVerificationLocal ? "enabled" : "disabled");
2454 return false;
2455 }
2456
2457 // For backwards compatibility, we don't check the BytecodeVerificationRemote setting
2458 // if the archive only contains system classes.
2459 if (_has_platform_or_app_classes
2460 && !_verify_remote // we didn't verify the archived platform/app classes
2461 && BytecodeVerificationRemote) { // but we want to verify all loaded platform/app classes
2462 log_info(cds)("The shared archive file was created with less restrictive "
2463 "verification setting than the current setting.");
2464 // Pretend that we didn't have any archived platform/app classes, so they won't be loaded
2465 // by SystemDictionaryShared.
2466 _has_platform_or_app_classes = false;
2467 }
2468
2469 // Java agents are allowed during run time. Therefore, the following condition is not
2470 // checked: (!_allow_archiving_with_java_agent && AllowArchivingWithJavaAgent)
2471 // Note: _allow_archiving_with_java_agent is set in the shared archive during dump time
2472 // while AllowArchivingWithJavaAgent is set during the current run.
2473 if (_allow_archiving_with_java_agent && !AllowArchivingWithJavaAgent) {
2474 log_warning(cds)("The setting of the AllowArchivingWithJavaAgent is different "
2475 "from the setting in the shared archive.");
2476 return false;
2477 }
2478
2479 if (_allow_archiving_with_java_agent) {
2480 log_warning(cds)("This archive was created with AllowArchivingWithJavaAgent. It should be used "
2481 "for testing purposes only and should not be used in a production environment");
2482 }
2483
2484 log_info(cds)("Archive was created with UseCompressedOops = %d, UseCompressedClassPointers = %d",
2485 compressed_oops(), compressed_class_pointers());
2486 if (compressed_oops() != UseCompressedOops || compressed_class_pointers() != UseCompressedClassPointers) {
2487 log_info(cds)("Unable to use shared archive.\nThe saved state of UseCompressedOops and UseCompressedClassPointers is "
2488 "different from runtime, CDS will be disabled.");
2489 return false;
2490 }
2491
2492 if (!_use_optimized_module_handling) {
2493 CDSConfig::stop_using_optimized_module_handling();
2494 log_info(cds)("optimized module handling: disabled because archive was created without optimized module handling");
2495 }
2496
2497 if (is_static() && !_has_full_module_graph) {
2498 // Only the static archive can contain the full module graph.
2499 CDSConfig::stop_using_full_module_graph("archive was created without full module graph");
2500 }
2501
2502 return true;
2503 }
2504
2505 bool FileMapInfo::validate_header() {
2506 if (!header()->validate()) {
2507 return false;
2508 }
2509 if (_is_static) {
2510 return true;
2511 } else {
2512 return DynamicArchive::validate(this);
2513 }
2514 }
2515
2516 #if INCLUDE_JVMTI
2517 ClassPathEntry** FileMapInfo::_classpath_entries_for_jvmti = nullptr;
2518
2519 ClassPathEntry* FileMapInfo::get_classpath_entry_for_jvmti(int i, TRAPS) {
2520 if (i == 0) {
2521 // index 0 corresponds to the ClassPathImageEntry which is a globally shared object
2522 // and should never be deleted.
2523 return ClassLoader::get_jrt_entry();
2524 }
2525 ClassPathEntry* ent = _classpath_entries_for_jvmti[i];
2526 if (ent == nullptr) {
2527 SharedClassPathEntry* scpe = shared_path(i);
2528 assert(scpe->is_jar(), "must be"); // other types of scpe will not produce archived classes
2529
2530 const char* path = scpe->name();
2531 struct stat st;
2532 if (os::stat(path, &st) != 0) {
2533 char *msg = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, strlen(path) + 128);
2534 jio_snprintf(msg, strlen(path) + 127, "error in finding JAR file %s", path);
2535 THROW_MSG_(vmSymbols::java_io_IOException(), msg, nullptr);
2536 } else {
2537 ent = ClassLoader::create_class_path_entry(THREAD, path, &st, false, false);
2538 if (ent == nullptr) {
2539 char *msg = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, strlen(path) + 128);
2540 jio_snprintf(msg, strlen(path) + 127, "error in opening JAR file %s", path);
2541 THROW_MSG_(vmSymbols::java_io_IOException(), msg, nullptr);
2542 }
2543 }
2544
2545 MutexLocker mu(THREAD, CDSClassFileStream_lock);
2546 if (_classpath_entries_for_jvmti[i] == nullptr) {
2547 _classpath_entries_for_jvmti[i] = ent;
2548 } else {
2549 // Another thread has beat me to creating this entry
2550 delete ent;
2551 ent = _classpath_entries_for_jvmti[i];
2552 }
2553 }
2554
2555 return ent;
2556 }
2557
2558 ClassFileStream* FileMapInfo::open_stream_for_jvmti(InstanceKlass* ik, Handle class_loader, TRAPS) {
2559 int path_index = ik->shared_classpath_index();
2560 assert(path_index >= 0, "should be called for shared built-in classes only");
2561 assert(path_index < (int)get_number_of_shared_paths(), "sanity");
2562
2563 ClassPathEntry* cpe = get_classpath_entry_for_jvmti(path_index, CHECK_NULL);
2564 assert(cpe != nullptr, "must be");
2565
2566 Symbol* name = ik->name();
2567 const char* const class_name = name->as_C_string();
2568 const char* const file_name = ClassLoader::file_name_for_class_name(class_name,
2569 name->utf8_length());
2570 ClassLoaderData* loader_data = ClassLoaderData::class_loader_data(class_loader());
2571 ClassFileStream* cfs = cpe->open_stream_for_loader(THREAD, file_name, loader_data);
2572 assert(cfs != nullptr, "must be able to read the classfile data of shared classes for built-in loaders.");
2573 log_debug(cds, jvmti)("classfile data for %s [%d: %s] = %d bytes", class_name, path_index,
2574 cfs->source(), cfs->length());
2575 return cfs;
2576 }
2577
2578 #endif