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