1 /*
2 * Copyright (c) 2012, 2026, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #include "cds/aotArtifactFinder.hpp"
26 #include "cds/aotClassInitializer.hpp"
27 #include "cds/aotClassLinker.hpp"
28 #include "cds/aotClassLocation.hpp"
29 #include "cds/aotConstantPoolResolver.hpp"
30 #include "cds/aotLinkedClassBulkLoader.hpp"
31 #include "cds/aotLogging.hpp"
32 #include "cds/aotMapLogger.hpp"
33 #include "cds/aotMappedHeapLoader.hpp"
34 #include "cds/aotMetaspace.hpp"
35 #include "cds/aotReferenceObjSupport.hpp"
36 #include "cds/archiveBuilder.hpp"
37 #include "cds/cds_globals.hpp"
38 #include "cds/cdsConfig.hpp"
39 #include "cds/cdsProtectionDomain.hpp"
40 #include "cds/classListParser.hpp"
41 #include "cds/classListWriter.hpp"
42 #include "cds/cppVtables.hpp"
43 #include "cds/dumpAllocStats.hpp"
44 #include "cds/dynamicArchive.hpp"
45 #include "cds/filemap.hpp"
46 #include "cds/finalImageRecipes.hpp"
47 #include "cds/heapShared.inline.hpp"
48 #include "cds/lambdaFormInvokers.hpp"
49 #include "cds/lambdaProxyClassDictionary.hpp"
50 #include "classfile/classLoaderDataGraph.hpp"
51 #include "classfile/classLoaderDataShared.hpp"
52 #include "classfile/javaClasses.inline.hpp"
53 #include "classfile/loaderConstraints.hpp"
54 #include "classfile/modules.hpp"
55 #include "classfile/placeholders.hpp"
56 #include "classfile/stringTable.hpp"
57 #include "classfile/symbolTable.hpp"
58 #include "classfile/systemDictionary.hpp"
59 #include "classfile/systemDictionaryShared.hpp"
60 #include "classfile/vmClasses.hpp"
61 #include "classfile/vmSymbols.hpp"
62 #include "code/aotCodeCache.hpp"
63 #include "code/codeCache.hpp"
64 #include "gc/shared/gcVMOperations.hpp"
65 #include "interpreter/bytecodes.hpp"
66 #include "interpreter/bytecodeStream.hpp"
67 #include "jvm_io.h"
68 #include "logging/log.hpp"
69 #include "logging/logMessage.hpp"
70 #include "logging/logStream.hpp"
71 #include "memory/memoryReserver.hpp"
72 #include "memory/metaspace.hpp"
73 #include "memory/metaspaceClosure.hpp"
74 #include "memory/oopFactory.hpp"
75 #include "memory/resourceArea.hpp"
76 #include "memory/universe.hpp"
77 #include "nmt/memTracker.hpp"
78 #include "oops/compressedKlass.hpp"
79 #include "oops/constantPool.inline.hpp"
80 #include "oops/flatArrayKlass.hpp"
81 #include "oops/inlineKlass.hpp"
82 #include "oops/instanceMirrorKlass.hpp"
83 #include "oops/klass.inline.hpp"
84 #include "oops/objArrayOop.hpp"
85 #include "oops/oop.inline.hpp"
86 #include "oops/oopHandle.hpp"
87 #include "oops/resolvedFieldEntry.hpp"
88 #include "oops/trainingData.hpp"
89 #include "prims/jvmtiExport.hpp"
90 #include "runtime/arguments.hpp"
91 #include "runtime/globals.hpp"
92 #include "runtime/globals_extension.hpp"
93 #include "runtime/handles.inline.hpp"
94 #include "runtime/javaCalls.hpp"
95 #include "runtime/os.inline.hpp"
96 #include "runtime/safepointVerifiers.hpp"
97 #include "runtime/sharedRuntime.hpp"
98 #include "runtime/vmOperations.hpp"
99 #include "runtime/vmThread.hpp"
100 #include "sanitizers/leak.hpp"
101 #include "services/management.hpp"
102 #include "utilities/align.hpp"
103 #include "utilities/bitMap.inline.hpp"
104 #include "utilities/defaultStream.hpp"
105 #include "utilities/hashTable.hpp"
106 #include "utilities/macros.hpp"
107 #include "utilities/ostream.hpp"
108
109 #include <sys/stat.h>
110
111 ReservedSpace AOTMetaspace::_symbol_rs;
112 VirtualSpace AOTMetaspace::_symbol_vs;
113 bool AOTMetaspace::_archive_loading_failed = false;
114 bool AOTMetaspace::_remapped_readwrite = false;
115 void* AOTMetaspace::_aot_metaspace_static_top = nullptr;
116 intx AOTMetaspace::_relocation_delta;
117 char* AOTMetaspace::_requested_base_address;
118 Array<Method*>* AOTMetaspace::_archived_method_handle_intrinsics = nullptr;
119 bool AOTMetaspace::_use_optimized_module_handling = true;
120 int volatile AOTMetaspace::_preimage_static_archive_dumped = 0;
121 FileMapInfo* AOTMetaspace::_output_mapinfo = nullptr;
122
123 // The CDS archive is divided into the following regions:
124 // rw - read-write metadata
125 // ro - read-only metadata and read-only tables
126 // hp - heap region
127 // bm - bitmap for relocating the above 7 regions.
128 //
129 // The rw and ro regions are linearly allocated, in the order of rw->ro.
130 // These regions are aligned with AOTMetaspace::core_region_alignment().
131 //
132 // These 2 regions are populated in the following steps:
133 // [0] All classes are loaded in AOTMetaspace::load_classes(). All metadata are
134 // temporarily allocated outside of the shared regions.
135 // [1] We enter a safepoint and allocate a buffer for the rw/ro regions.
136 // [2] C++ vtables are copied into the rw region.
137 // [3] ArchiveBuilder copies RW metadata into the rw region.
138 // [4] ArchiveBuilder copies RO metadata into the ro region.
139 // [5] SymbolTable, StringTable, SystemDictionary, and a few other read-only data
140 // are copied into the ro region as read-only tables.
141 //
142 // The heap region is written by HeapShared::write_heap().
143 //
144 // The bitmap region is used to relocate the ro/rw/hp regions.
145
146 static DumpRegion _symbol_region("symbols");
147
148 char* AOTMetaspace::symbol_space_alloc(size_t num_bytes) {
149 return _symbol_region.allocate(num_bytes);
150 }
151
152 // os::vm_allocation_granularity() is usually 4K for most OSes. However, some platforms
153 // such as linux-aarch64 and macos-x64 ...
154 // it can be either 4K or 64K and on macos-aarch64 it is 16K. To generate archives that are
155 // compatible for both settings, an alternative cds core region alignment can be enabled
156 // at building time:
157 // --enable-compactible-cds-alignment
158 // Upon successful configuration, the compactible alignment then can be defined in:
159 // os_linux_aarch64.cpp
160 // os_bsd_x86.cpp
161 size_t AOTMetaspace::core_region_alignment() {
162 return os::cds_core_region_alignment();
163 }
164
165 size_t AOTMetaspace::protection_zone_size() {
166 return os::cds_core_region_alignment();
167 }
168
169 static bool shared_base_valid(char* shared_base) {
170 // We check user input for SharedBaseAddress at dump time.
171
172 // At CDS runtime, "shared_base" will be the (attempted) mapping start. It will also
173 // be the encoding base, since the headers of archived base objects (and with Lilliput,
174 // the prototype mark words) carry pre-computed narrow Klass IDs that refer to the mapping
175 // start as base.
176 //
177 // On AARCH64, The "shared_base" may not be later usable as encoding base, depending on the
178 // total size of the reserved area and the precomputed_narrow_klass_shift. This is checked
179 // before reserving memory. Here we weed out values already known to be invalid later.
180 return AARCH64_ONLY(is_aligned(shared_base, 4 * G)) NOT_AARCH64(true);
181 }
182
183 class DumpClassListCLDClosure : public CLDClosure {
184 static const int INITIAL_TABLE_SIZE = 1987;
185 static const int MAX_TABLE_SIZE = 61333;
186
187 fileStream *_stream;
188 ResizeableHashTable<InstanceKlass*, bool,
189 AnyObj::C_HEAP, mtClassShared> _dumped_classes;
190
191 void dump(InstanceKlass* ik) {
192 bool created;
193 _dumped_classes.put_if_absent(ik, &created);
194 if (!created) {
195 return;
196 }
197 if (_dumped_classes.maybe_grow()) {
198 log_info(aot, hashtables)("Expanded _dumped_classes table to %d", _dumped_classes.table_size());
199 }
200 if (ik->super()) {
201 dump(ik->super());
202 }
203 Array<InstanceKlass*>* interfaces = ik->local_interfaces();
204 int len = interfaces->length();
205 for (int i = 0; i < len; i++) {
206 dump(interfaces->at(i));
207 }
208 ClassListWriter::write_to_stream(ik, _stream);
209 }
210
211 public:
212 DumpClassListCLDClosure(fileStream* f)
213 : CLDClosure(), _dumped_classes(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE) {
214 _stream = f;
215 }
216
217 void do_cld(ClassLoaderData* cld) {
218 for (Klass* klass = cld->klasses(); klass != nullptr; klass = klass->next_link()) {
219 if (klass->is_instance_klass()) {
220 dump(InstanceKlass::cast(klass));
221 }
222 }
223 }
224 };
225
226 void AOTMetaspace::dump_loaded_classes(const char* file_name, TRAPS) {
227 fileStream stream(file_name, "w");
228 if (stream.is_open()) {
229 MutexLocker lock(ClassLoaderDataGraph_lock);
230 MutexLocker lock2(ClassListFile_lock, Mutex::_no_safepoint_check_flag);
231 DumpClassListCLDClosure collect_classes(&stream);
232 ClassLoaderDataGraph::loaded_cld_do(&collect_classes);
233 } else {
234 THROW_MSG(vmSymbols::java_io_IOException(), "Failed to open file");
235 }
236 }
237
238 static bool shared_base_too_high(char* specified_base, char* aligned_base, size_t cds_max) {
239 // Caller should have checked that aligned_base was successfully aligned and is not nullptr.
240 // Comparing specified_base with nullptr is UB.
241 assert(aligned_base != nullptr, "sanity");
242 assert(aligned_base >= specified_base, "sanity");
243
244 if (max_uintx - uintx(aligned_base) < uintx(cds_max)) {
245 // Not enough address space to hold an archive of cds_max bytes from aligned_base.
246 return true;
247 } else {
248 return false;
249 }
250 }
251
252 static char* compute_shared_base(size_t cds_max) {
253 char* specified_base = (char*)SharedBaseAddress;
254 size_t alignment = AOTMetaspace::core_region_alignment();
255 if (UseCompressedClassPointers && CompressedKlassPointers::needs_class_space()) {
256 alignment = MAX2(alignment, Metaspace::reserve_alignment());
257 }
258
259 if (SharedBaseAddress == 0) {
260 // Special meaning of -XX:SharedBaseAddress=0 -> Always map archive at os-selected address.
261 return specified_base;
262 }
263
264 char* aligned_base = can_align_up(specified_base, alignment)
265 ? align_up(specified_base, alignment)
266 : nullptr;
267
268 if (aligned_base != specified_base) {
269 aot_log_info(aot)("SharedBaseAddress (" INTPTR_FORMAT ") aligned up to " INTPTR_FORMAT,
270 p2i(specified_base), p2i(aligned_base));
271 }
272
273 const char* err = nullptr;
274 if (aligned_base == nullptr) {
275 err = "too high";
276 } else if (shared_base_too_high(specified_base, aligned_base, cds_max)) {
277 err = "too high";
278 } else if (!shared_base_valid(aligned_base)) {
279 err = "invalid for this platform";
280 } else {
281 return aligned_base;
282 }
283
284 // Arguments::default_SharedBaseAddress() is hard-coded in cds_globals.hpp. It must be carefully
285 // picked that (a) the align_up() below will always return a valid value; (b) none of
286 // the following asserts will fail.
287 aot_log_warning(aot)("SharedBaseAddress (" INTPTR_FORMAT ") is %s. Reverted to " INTPTR_FORMAT,
288 p2i((void*)SharedBaseAddress), err,
289 p2i((void*)Arguments::default_SharedBaseAddress()));
290
291 specified_base = (char*)Arguments::default_SharedBaseAddress();
292 aligned_base = align_up(specified_base, alignment);
293
294 // Make sure the default value of SharedBaseAddress specified in globals.hpp is sane.
295 assert(!shared_base_too_high(specified_base, aligned_base, cds_max), "Sanity");
296 assert(shared_base_valid(aligned_base), "Sanity");
297 return aligned_base;
298 }
299
300 void AOTMetaspace::initialize_for_static_dump() {
301 assert(CDSConfig::is_dumping_static_archive(), "sanity");
302 aot_log_info(aot)("Core region alignment: %zu", core_region_alignment());
303 // The max allowed size for CDS archive. We use this to limit SharedBaseAddress
304 // to avoid address space wrap around.
305 size_t cds_max;
306 const size_t reserve_alignment = core_region_alignment();
307
308 #ifdef _LP64
309 const uint64_t UnscaledClassSpaceMax = (uint64_t(max_juint) + 1);
310 cds_max = align_down(UnscaledClassSpaceMax, reserve_alignment);
311 #else
312 // We don't support archives larger than 256MB on 32-bit due to limited
313 // virtual address space.
314 cds_max = align_down(256*M, reserve_alignment);
315 #endif
316
317 _requested_base_address = compute_shared_base(cds_max);
318 SharedBaseAddress = (size_t)_requested_base_address;
319
320 size_t symbol_rs_size = LP64_ONLY(3 * G) NOT_LP64(128 * M);
321 _symbol_rs = MemoryReserver::reserve(symbol_rs_size,
322 os::vm_allocation_granularity(),
323 os::vm_page_size(),
324 mtClassShared);
325 if (!_symbol_rs.is_reserved()) {
326 aot_log_error(aot)("Unable to reserve memory for symbols: %zu bytes.", symbol_rs_size);
327 AOTMetaspace::unrecoverable_writing_error();
328 }
329 _symbol_region.init(&_symbol_rs, &_symbol_vs);
330 if (CDSConfig::is_dumping_preimage_static_archive()) {
331 // We are in the AOT training run. User code is executed.
332 //
333 // On Windows, if the user code closes System.out and we open the AOT config file for output
334 // only at VM exit, we might get back the same file HANDLE as stdout, and the AOT config
335 // file may get corrupted by UL logs. By opening early, we ensure that the output
336 // HANDLE is different than stdout so we can avoid such corruption.
337 open_output_mapinfo();
338 } else {
339 // No need for the above as we won't execute any user code.
340 }
341 }
342
343 void AOTMetaspace::open_output_mapinfo() {
344 const char* static_archive = CDSConfig::output_archive_path();
345 assert(static_archive != nullptr, "sanity");
346 _output_mapinfo = new FileMapInfo(static_archive, true);
347 _output_mapinfo->open_as_output();
348 }
349
350 // Called by universe_post_init()
351 void AOTMetaspace::post_initialize(TRAPS) {
352 if (CDSConfig::is_using_archive()) {
353 FileMapInfo *static_mapinfo = FileMapInfo::current_info();
354 FileMapInfo *dynamic_mapinfo = FileMapInfo::dynamic_info();
355
356 if (AOTMapLogger::is_logging_at_bootstrap()) {
357 // The map logging needs to be done here, as it requires some stubs on Windows,
358 // which are not generated until the end of init_globals().
359 AOTMapLogger::runtime_log(static_mapinfo, dynamic_mapinfo);
360 }
361
362 // Close any open file descriptors. However, mmap'ed pages will remain in memory.
363 static_mapinfo->close();
364
365 if (HeapShared::is_loading() && HeapShared::is_loading_mapping_mode()) {
366 static_mapinfo->unmap_region(AOTMetaspace::bm);
367 }
368
369 if (dynamic_mapinfo != nullptr) {
370 dynamic_mapinfo->close();
371 dynamic_mapinfo->unmap_region(AOTMetaspace::bm);
372 }
373
374 int size = AOTClassLocationConfig::runtime()->length();
375 if (size > 0) {
376 CDSProtectionDomain::allocate_shared_data_arrays(size, CHECK);
377 }
378 }
379 }
380
381 // Extra java.lang.Strings to be added to the archive
382 static GrowableArrayCHeap<OopHandle, mtClassShared>* _extra_interned_strings = nullptr;
383 // Extra Symbols to be added to the archive
384 static GrowableArrayCHeap<Symbol*, mtClassShared>* _extra_symbols = nullptr;
385 // Methods managed by SystemDictionary::find_method_handle_intrinsic() to be added to the archive
386 static GrowableArray<Method*>* _pending_method_handle_intrinsics = nullptr;
387
388 void AOTMetaspace::read_extra_data(JavaThread* current, const char* filename) {
389 _extra_interned_strings = new GrowableArrayCHeap<OopHandle, mtClassShared>(10000);
390 _extra_symbols = new GrowableArrayCHeap<Symbol*, mtClassShared>(1000);
391
392 HashtableTextDump reader(filename);
393 reader.check_version("VERSION: 1.0");
394
395 while (reader.remain() > 0) {
396 int utf8_length;
397 int prefix_type = reader.scan_prefix(&utf8_length);
398 ResourceMark rm(current);
399 if (utf8_length == 0x7fffffff) {
400 // buf_len will overflown 32-bit value.
401 aot_log_error(aot)("string length too large: %d", utf8_length);
402 AOTMetaspace::unrecoverable_loading_error();
403 }
404 int buf_len = utf8_length+1;
405 char* utf8_buffer = NEW_RESOURCE_ARRAY(char, buf_len);
406 reader.get_utf8(utf8_buffer, utf8_length);
407 utf8_buffer[utf8_length] = '\0';
408
409 if (prefix_type == HashtableTextDump::SymbolPrefix) {
410 _extra_symbols->append(SymbolTable::new_permanent_symbol(utf8_buffer));
411 } else{
412 assert(prefix_type == HashtableTextDump::StringPrefix, "Sanity");
413 ExceptionMark em(current);
414 JavaThread* THREAD = current; // For exception macros.
415 oop str = StringTable::intern(utf8_buffer, THREAD);
416
417 if (HAS_PENDING_EXCEPTION) {
418 log_warning(aot, heap)("[line %d] extra interned string allocation failed; size too large: %d",
419 reader.last_line_no(), utf8_length);
420 CLEAR_PENDING_EXCEPTION;
421 } else {
422 #if INCLUDE_CDS_JAVA_HEAP
423 if (HeapShared::is_string_too_large_to_archive(str)) {
424 log_warning(aot, heap)("[line %d] extra interned string ignored; size too large: %d",
425 reader.last_line_no(), utf8_length);
426 continue;
427 }
428 // Make sure this string is included in the dumped interned string table.
429 assert(str != nullptr, "must succeed");
430 _extra_interned_strings->append(OopHandle(Universe::vm_global(), str));
431 #endif
432 }
433 }
434 }
435 }
436
437 void AOTMetaspace::make_method_handle_intrinsics_shareable() {
438 for (int i = 0; i < _pending_method_handle_intrinsics->length(); i++) {
439 Method* m = ArchiveBuilder::current()->get_buffered_addr(_pending_method_handle_intrinsics->at(i));
440 m->remove_unshareable_info();
441 // Each method has its own constant pool (which is distinct from m->method_holder()->constants());
442 m->constants()->remove_unshareable_info();
443 }
444 }
445
446 void AOTMetaspace::write_method_handle_intrinsics() {
447 int len = _pending_method_handle_intrinsics->length();
448 _archived_method_handle_intrinsics = ArchiveBuilder::new_ro_array<Method*>(len);
449 int word_size = _archived_method_handle_intrinsics->size();
450 for (int i = 0; i < len; i++) {
451 Method* m = _pending_method_handle_intrinsics->at(i);
452 ArchiveBuilder::current()->write_pointer_in_buffer(_archived_method_handle_intrinsics->adr_at(i), m);
453 word_size += m->size() + m->constMethod()->size() + m->constants()->size();
454 if (m->constants()->cache() != nullptr) {
455 word_size += m->constants()->cache()->size();
456 }
457 }
458 log_info(aot)("Archived %d method handle intrinsics (%d bytes)", len, word_size * BytesPerWord);
459 }
460
461 // About "serialize" --
462 //
463 // This is (probably a badly named) way to read/write a data stream of pointers and
464 // miscellaneous data from/to the shared archive file. The usual code looks like this:
465 //
466 // // These two global C++ variables are initialized during dump time.
467 // static int _archived_int;
468 // static MetaspaceObj* archived_ptr;
469 //
470 // void MyClass::serialize(SerializeClosure* soc) {
471 // soc->do_int(&_archived_int);
472 // soc->do_int(&_archived_ptr);
473 // }
474 //
475 // At dumptime, these two variables are stored into the CDS archive.
476 // At runtime, these two variables are loaded from the CDS archive.
477 // In addition, the pointer is relocated as necessary.
478 //
479 // Some of the xxx::serialize() functions may have side effects and assume that
480 // the archive is already mapped. For example, SymbolTable::serialize_shared_table_header()
481 // unconditionally makes the set of archived symbols available. Therefore, we put most
482 // of these xxx::serialize() functions inside AOTMetaspace::serialize(), which
483 // is called AFTER we made the decision to map the archive.
484 //
485 // However, some of the "serialized" data are used to decide whether an archive should
486 // be mapped or not (e.g., for checking if the -Djdk.module.main property is compatible
487 // with the archive). The xxx::serialize() functions for these data must be put inside
488 // AOTMetaspace::early_serialize(). Such functions must not produce side effects that
489 // assume we will always decides to map the archive.
490
491 void AOTMetaspace::early_serialize(SerializeClosure* soc) {
492 int tag = 0;
493 soc->do_tag(--tag);
494 CDS_JAVA_HEAP_ONLY(Modules::serialize_archived_module_info(soc);)
495 soc->do_tag(666);
496 }
497
498 void AOTMetaspace::serialize(SerializeClosure* soc) {
499 int tag = 0;
500 soc->do_tag(--tag);
501
502 // Verify the sizes of various metadata in the system.
503 soc->do_tag(sizeof(Method));
504 soc->do_tag(sizeof(ConstMethod));
505 soc->do_tag(arrayOopDesc::base_offset_in_bytes(T_BYTE));
506 soc->do_tag(sizeof(ConstantPool));
507 soc->do_tag(sizeof(ConstantPoolCache));
508 soc->do_tag(refArrayOopDesc::base_offset_in_bytes());
509 soc->do_tag(typeArrayOopDesc::base_offset_in_bytes(T_BYTE));
510 soc->do_tag(sizeof(Symbol));
511
512 // Need to do this first, as subsequent steps may call virtual functions
513 // in archived Metadata objects.
514 CppVtables::serialize(soc);
515 soc->do_tag(--tag);
516
517 // Dump/restore miscellaneous metadata.
518 JavaClasses::serialize_offsets(soc);
519 Universe::serialize(soc);
520 soc->do_tag(--tag);
521
522 // Dump/restore references to commonly used names and signatures.
523 vmSymbols::serialize(soc);
524 soc->do_tag(--tag);
525
526 // Dump/restore the symbol/string/subgraph_info tables
527 SymbolTable::serialize_shared_table_header(soc);
528 StringTable::serialize_shared_table_header(soc);
529 HeapShared::serialize_tables(soc);
530 SystemDictionaryShared::serialize_dictionary_headers(soc);
531 AOTLinkedClassBulkLoader::serialize(soc);
532 FinalImageRecipes::serialize(soc);
533 TrainingData::serialize(soc);
534 InstanceMirrorKlass::serialize_offsets(soc);
535
536 // Dump/restore well known classes (pointers)
537 SystemDictionaryShared::serialize_vm_classes(soc);
538 soc->do_tag(--tag);
539
540 CDS_JAVA_HEAP_ONLY(ClassLoaderDataShared::serialize(soc);)
541 soc->do_ptr((void**)&_archived_method_handle_intrinsics);
542
543 LambdaFormInvokers::serialize(soc);
544 AdapterHandlerLibrary::serialize_shared_table_header(soc);
545
546 soc->do_tag(666);
547 }
548
549 // In AOTCache workflow, when dumping preimage, the constant pool entries are stored in unresolved state.
550 // So the fast version of getfield/putfield needs to be converted to nofast version.
551 // When dumping the final image in the assembly phase, these nofast versions are converted back to fast versions
552 // if the constant pool entry refered by these bytecodes is stored in resolved state.
553 // Same principle applies to static and dynamic archives. If the constant pool entry is in resolved state, then
554 // the fast version of the bytecodes can be preserved, else use the nofast version.
555 //
556 // The fast versions of aload_0 (i.e. _fast_Xaccess_0) merges the bytecode pair (aload_0, fast_Xgetfield).
557 // If the fast version of aload_0 is preserved in AOTCache, then the JVMTI notifications for field access and
558 // breakpoint events will be skipped for the second bytecode (fast_Xgetfield) in the pair.
559 // Same holds for fast versions of iload_0. So for these bytecodes, nofast version is used.
560 static void rewrite_bytecodes(const methodHandle& method) {
561 ConstantPool* cp = method->constants();
562 BytecodeStream bcs(method);
563 Bytecodes::Code new_code;
564
565 LogStreamHandle(Trace, aot, resolve) lsh;
566 if (lsh.is_enabled()) {
567 lsh.print("Rewriting bytecodes for ");
568 method()->print_external_name(&lsh);
569 lsh.print("\n");
570 }
571
572 while (!bcs.is_last_bytecode()) {
573 Bytecodes::Code opcode = bcs.next();
574 // Use current opcode as the default value of new_code
575 new_code = opcode;
576 switch(opcode) {
577 case Bytecodes::_getfield: {
578 uint rfe_index = bcs.get_index_u2();
579 bool is_resolved = cp->is_resolved(rfe_index, opcode);
580 if (is_resolved) {
581 assert(!CDSConfig::is_dumping_preimage_static_archive(), "preimage should not have resolved field references");
582 ResolvedFieldEntry* rfe = cp->resolved_field_entry_at(bcs.get_index_u2());
583 switch(rfe->tos_state()) {
584 case btos:
585 // fallthrough
586 case ztos: new_code = Bytecodes::_fast_bgetfield; break;
587 case atos: {
588 if (rfe->is_flat()) {
589 new_code = Bytecodes::_fast_vgetfield;
590 } else {
591 new_code = Bytecodes::_fast_agetfield;
592 }
593 break;
594 }
595 case itos: new_code = Bytecodes::_fast_igetfield; break;
596 case ctos: new_code = Bytecodes::_fast_cgetfield; break;
597 case stos: new_code = Bytecodes::_fast_sgetfield; break;
598 case ltos: new_code = Bytecodes::_fast_lgetfield; break;
599 case ftos: new_code = Bytecodes::_fast_fgetfield; break;
600 case dtos: new_code = Bytecodes::_fast_dgetfield; break;
601 default:
602 ShouldNotReachHere();
603 break;
604 }
605 } else {
606 new_code = Bytecodes::_nofast_getfield;
607 }
608 break;
609 }
610 case Bytecodes::_putfield: {
611 uint rfe_index = bcs.get_index_u2();
612 bool is_resolved = cp->is_resolved(rfe_index, opcode);
613 if (is_resolved) {
614 assert(!CDSConfig::is_dumping_preimage_static_archive(), "preimage should not have resolved field references");
615 ResolvedFieldEntry* rfe = cp->resolved_field_entry_at(bcs.get_index_u2());
616 switch(rfe->tos_state()) {
617 case btos: new_code = Bytecodes::_fast_bputfield; break;
618 case ztos: new_code = Bytecodes::_fast_zputfield; break;
619 case atos: {
620 if (rfe->is_flat() || rfe->is_null_free_inline_type()) {
621 new_code = Bytecodes::_fast_vputfield;
622 } else {
623 new_code = Bytecodes::_fast_aputfield;
624 }
625 break;
626 }
627 case itos: new_code = Bytecodes::_fast_iputfield; break;
628 case ctos: new_code = Bytecodes::_fast_cputfield; break;
629 case stos: new_code = Bytecodes::_fast_sputfield; break;
630 case ltos: new_code = Bytecodes::_fast_lputfield; break;
631 case ftos: new_code = Bytecodes::_fast_fputfield; break;
632 case dtos: new_code = Bytecodes::_fast_dputfield; break;
633 default:
634 ShouldNotReachHere();
635 break;
636 }
637 } else {
638 new_code = Bytecodes::_nofast_putfield;
639 }
640 break;
641 }
642 case Bytecodes::_aload_0:
643 // Revert _fast_Xaccess_0 or _aload_0 to _nofast_aload_0
644 new_code = Bytecodes::_nofast_aload_0;
645 break;
646 case Bytecodes::_iload:
647 if (!bcs.is_wide()) {
648 new_code = Bytecodes::_nofast_iload;
649 }
650 break;
651 default:
652 break;
653 }
654 if (opcode != new_code) {
655 *bcs.bcp() = new_code;
656 if (lsh.is_enabled()) {
657 lsh.print_cr("%d:%s -> %s", bcs.bci(), Bytecodes::name(opcode), Bytecodes::name(new_code));
658 }
659 }
660 }
661 }
662
663 // [1] Rewrite all bytecodes as needed, so that the ConstMethod* will not be modified
664 // at run time by RewriteBytecodes/RewriteFrequentPairs
665 // [2] Assign a fingerprint, so one doesn't need to be assigned at run-time.
666 void AOTMetaspace::rewrite_bytecodes_and_calculate_fingerprints(Thread* thread, InstanceKlass* ik) {
667 for (int i = 0; i < ik->methods()->length(); i++) {
668 methodHandle m(thread, ik->methods()->at(i));
669 if (ik->can_be_verified_at_dumptime() && ik->is_linked()) {
670 rewrite_bytecodes(m);
671 }
672 Fingerprinter fp(m);
673 // The side effect of this call sets method's fingerprint field.
674 fp.fingerprint();
675 }
676 }
677
678 class VM_PopulateDumpSharedSpace : public VM_Operation {
679 private:
680 AOTMappedHeapInfo _mapped_heap_info;
681 AOTStreamedHeapInfo _streamed_heap_info;
682 FileMapInfo* _map_info;
683 StaticArchiveBuilder& _builder;
684
685 void dump_java_heap_objects();
686 void dump_shared_symbol_table(GrowableArray<Symbol*>* symbols) {
687 log_info(aot)("Dumping symbol table ...");
688 SymbolTable::write_to_archive(symbols);
689 }
690 char* dump_early_read_only_tables();
691 char* dump_read_only_tables(AOTClassLocationConfig*& cl_config);
692
693 public:
694
695 VM_PopulateDumpSharedSpace(StaticArchiveBuilder& b, FileMapInfo* map_info) :
696 VM_Operation(), _mapped_heap_info(), _streamed_heap_info(), _map_info(map_info), _builder(b) {}
697
698 bool skip_operation() const { return false; }
699
700 VMOp_Type type() const { return VMOp_PopulateDumpSharedSpace; }
701 AOTMappedHeapInfo* mapped_heap_info() { return &_mapped_heap_info; }
702 AOTStreamedHeapInfo* streamed_heap_info() { return &_streamed_heap_info; }
703 void doit(); // outline because gdb sucks
704 bool allow_nested_vm_operations() const { return true; }
705 }; // class VM_PopulateDumpSharedSpace
706
707 class StaticArchiveBuilder : public ArchiveBuilder {
708 public:
709 StaticArchiveBuilder() : ArchiveBuilder() {}
710
711 virtual void iterate_roots(MetaspaceClosure* it) {
712 AOTArtifactFinder::all_cached_classes_do(it);
713 SystemDictionaryShared::dumptime_classes_do(it);
714 Universe::metaspace_pointers_do(it);
715 vmSymbols::metaspace_pointers_do(it);
716 TrainingData::iterate_roots(it);
717 if (CDSConfig::is_dumping_full_module_graph()) {
718 ClassLoaderDataShared::iterate_roots(it);
719 }
720
721 // The above code should find all the symbols that are referenced by the
722 // archived classes. We just need to add the extra symbols which
723 // may not be used by any of the archived classes -- these are usually
724 // symbols that we anticipate to be used at run time, so we can store
725 // them in the RO region, to be shared across multiple processes.
726 if (_extra_symbols != nullptr) {
727 for (int i = 0; i < _extra_symbols->length(); i++) {
728 it->push(_extra_symbols->adr_at(i));
729 }
730 }
731
732 for (int i = 0; i < _pending_method_handle_intrinsics->length(); i++) {
733 it->push(_pending_method_handle_intrinsics->adr_at(i));
734 }
735 }
736 };
737
738 char* VM_PopulateDumpSharedSpace::dump_early_read_only_tables() {
739 ArchiveBuilder::OtherROAllocMark mark;
740
741 CDS_JAVA_HEAP_ONLY(Modules::dump_archived_module_info());
742
743 DumpRegion* ro_region = ArchiveBuilder::current()->ro_region();
744 char* start = ro_region->top();
745 WriteClosure wc(ro_region);
746 AOTMetaspace::early_serialize(&wc);
747 return start;
748 }
749
750 char* VM_PopulateDumpSharedSpace::dump_read_only_tables(AOTClassLocationConfig*& cl_config) {
751 ArchiveBuilder::OtherROAllocMark mark;
752
753 SystemDictionaryShared::write_to_archive();
754 cl_config = AOTClassLocationConfig::dumptime()->write_to_archive();
755 AOTClassLinker::write_to_archive();
756 if (CDSConfig::is_dumping_preimage_static_archive()) {
757 FinalImageRecipes::record_recipes();
758 }
759
760 TrainingData::dump_training_data();
761
762 AOTMetaspace::write_method_handle_intrinsics();
763
764 // Write lambform lines into archive
765 LambdaFormInvokers::dump_static_archive_invokers();
766
767 if (CDSConfig::is_dumping_adapters()) {
768 AdapterHandlerLibrary::dump_aot_adapter_table();
769 }
770
771 // Write the other data to the output array.
772 DumpRegion* ro_region = ArchiveBuilder::current()->ro_region();
773 char* start = ro_region->top();
774 WriteClosure wc(ro_region);
775 AOTMetaspace::serialize(&wc);
776
777 return start;
778 }
779
780 void VM_PopulateDumpSharedSpace::doit() {
781 CDSConfig::set_is_at_aot_safepoint(true);
782
783 if (!CDSConfig::is_dumping_final_static_archive()) {
784 guarantee(!CDSConfig::is_using_archive(), "We should not be using an archive when we dump");
785 }
786
787 DEBUG_ONLY(SystemDictionaryShared::NoClassLoadingMark nclm);
788
789 _pending_method_handle_intrinsics = new (mtClassShared) GrowableArray<Method*>(256, mtClassShared);
790 if (CDSConfig::is_dumping_method_handles()) {
791 // When dumping AOT-linked classes, some classes may have direct references to a method handle
792 // intrinsic. The easiest thing is to save all of them into the AOT cache.
793 SystemDictionary::get_all_method_handle_intrinsics(_pending_method_handle_intrinsics);
794 }
795
796 AOTClassLocationConfig::dumptime_check_nonempty_dirs();
797
798 NOT_PRODUCT(SystemDictionary::verify();)
799
800 // Block concurrent class unloading from changing the _dumptime_table
801 MutexLocker ml(DumpTimeTable_lock, Mutex::_no_safepoint_check_flag);
802
803 _builder.gather_source_objs();
804 _builder.reserve_buffer();
805
806 CppVtables::dumptime_init(&_builder);
807
808 _builder.sort_metadata_objs();
809 _builder.dump_rw_metadata();
810 _builder.dump_ro_metadata();
811 _builder.relocate_metaspaceobj_embedded_pointers();
812
813 log_info(aot)("Make classes shareable");
814 _builder.make_klasses_shareable();
815 AOTMetaspace::make_method_handle_intrinsics_shareable();
816
817 if (CDSConfig::is_dumping_full_module_graph()) {
818 ClassLoaderDataShared::remove_unshareable_info();
819 }
820
821 dump_java_heap_objects();
822 dump_shared_symbol_table(_builder.symbols());
823
824 char* early_serialized_data = dump_early_read_only_tables();
825 AOTClassLocationConfig* cl_config;
826 char* serialized_data = dump_read_only_tables(cl_config);
827
828 if (CDSConfig::is_dumping_lambdas_in_legacy_mode()) {
829 log_info(aot)("Adjust lambda proxy class dictionary");
830 LambdaProxyClassDictionary::adjust_dumptime_table();
831 }
832
833 log_info(cds)("Make training data shareable");
834 _builder.make_training_data_shareable();
835
836 // The vtable clones contain addresses of the current process.
837 // We don't want to write these addresses into the archive.
838 CppVtables::zero_archived_vtables();
839
840 // Write the archive file
841 _map_info->populate_header(AOTMetaspace::core_region_alignment());
842 _map_info->set_early_serialized_data(early_serialized_data);
843 _map_info->set_serialized_data(serialized_data);
844 _map_info->set_cloned_vtables(CppVtables::vtables_serialized_base());
845 _map_info->header()->set_class_location_config(cl_config);
846
847 HeapShared::delete_tables_with_raw_oops();
848 CDSConfig::set_is_at_aot_safepoint(false);
849 }
850
851 class CollectClassesForLinking : public KlassClosure {
852 GrowableArray<OopHandle> _mirrors;
853
854 public:
855 CollectClassesForLinking() : _mirrors() {
856 // ClassLoaderDataGraph::loaded_classes_do_keepalive() requires ClassLoaderDataGraph_lock.
857 // We cannot link the classes while holding this lock (or else we may run into deadlock).
858 // Therefore, we need to first collect all the classes, keeping them alive by
859 // holding onto their java_mirrors in global OopHandles. We then link the classes after
860 // releasing the lock.
861 MutexLocker lock(ClassLoaderDataGraph_lock);
862 ClassLoaderDataGraph::loaded_classes_do_keepalive(this);
863 }
864
865 ~CollectClassesForLinking() {
866 for (int i = 0; i < _mirrors.length(); i++) {
867 _mirrors.at(i).release(Universe::vm_global());
868 }
869 }
870
871 void do_cld(ClassLoaderData* cld) {
872 assert(cld->is_alive(), "must be");
873 }
874
875 void do_klass(Klass* k) {
876 if (k->is_instance_klass()) {
877 _mirrors.append(OopHandle(Universe::vm_global(), k->java_mirror()));
878 }
879 }
880
881 const GrowableArray<OopHandle>* mirrors() const { return &_mirrors; }
882 };
883
884 // Check if we can eagerly link this class at dump time, so we can avoid the
885 // runtime linking overhead (especially verification)
886 bool AOTMetaspace::may_be_eagerly_linked(InstanceKlass* ik) {
887 if (!ik->can_be_verified_at_dumptime()) {
888 // For old classes, try to leave them in the unlinked state, so
889 // we can still store them in the archive. They must be
890 // linked/verified at runtime.
891 return false;
892 }
893 if (CDSConfig::is_dumping_dynamic_archive() && ik->defined_by_other_loaders()) {
894 // Linking of unregistered classes at this stage may cause more
895 // classes to be resolved, resulting in calls to ClassLoader.loadClass()
896 // that may not be expected by custom class loaders.
897 //
898 // It's OK to do this for the built-in loaders as we know they can
899 // tolerate this.
900 return false;
901 }
902 return true;
903 }
904
905 void AOTMetaspace::link_all_loaded_classes(JavaThread* current) {
906 while (true) {
907 ResourceMark rm(current);
908 CollectClassesForLinking collect_classes;
909 bool has_linked = false;
910 const GrowableArray<OopHandle>* mirrors = collect_classes.mirrors();
911 for (int i = 0; i < mirrors->length(); i++) {
912 OopHandle mirror = mirrors->at(i);
913 InstanceKlass* ik = java_lang_Class::as_InstanceKlass(mirror.resolve());
914 if (may_be_eagerly_linked(ik)) {
915 has_linked |= try_link_class(current, ik);
916 }
917 }
918
919 if (!has_linked) {
920 break;
921 }
922 // Class linking includes verification which may load more classes.
923 // Keep scanning until we have linked no more classes.
924 }
925 }
926
927 void AOTMetaspace::link_shared_classes(TRAPS) {
928 AOTClassLinker::initialize();
929 AOTClassInitializer::init_test_class(CHECK);
930
931 if (CDSConfig::is_dumping_final_static_archive()) {
932 // - Load and link all classes used in the training run.
933 // - Initialize @AOTSafeClassInitializer classes that were
934 // initialized in the training run.
935 // - Perform per-class optimization such as AOT-resolution of
936 // constant pool entries that were resolved during the training run.
937 FinalImageRecipes::apply_recipes(CHECK);
938
939 // Because the AOT assembly phase does not run the same exact code as in the
940 // training run (e.g., we use different lambda form invoker classes;
941 // generated lambda form classes are not recorded in FinalImageRecipes),
942 // the recipes do not cover all classes that have been loaded so far. As
943 // a result, we might have some unlinked classes at this point. Since we
944 // require cached classes to be linked, all such classes will be linked
945 // by the following step.
946 }
947
948 link_all_loaded_classes(THREAD);
949
950 // Eargerly resolve all string constants in constant pools
951 {
952 ResourceMark rm(THREAD);
953 CollectClassesForLinking collect_classes;
954 const GrowableArray<OopHandle>* mirrors = collect_classes.mirrors();
955 for (int i = 0; i < mirrors->length(); i++) {
956 OopHandle mirror = mirrors->at(i);
957 InstanceKlass* ik = java_lang_Class::as_InstanceKlass(mirror.resolve());
958 AOTConstantPoolResolver::preresolve_string_cp_entries(ik, CHECK);
959 }
960 }
961 }
962
963 void AOTMetaspace::dump_static_archive(TRAPS) {
964 CDSConfig::DumperThreadMark dumper_thread_mark(THREAD);
965 ResourceMark rm(THREAD);
966 HandleMark hm(THREAD);
967
968 if (CDSConfig::is_dumping_final_static_archive() && AOTPrintTrainingInfo) {
969 tty->print_cr("==================== archived_training_data ** before dumping ====================");
970 TrainingData::print_archived_training_data_on(tty);
971 }
972
973 StaticArchiveBuilder builder;
974 dump_static_archive_impl(builder, THREAD);
975 if (HAS_PENDING_EXCEPTION) {
976 if (PENDING_EXCEPTION->is_a(vmClasses::OutOfMemoryError_klass())) {
977 aot_log_error(aot)("Out of memory. Please run with a larger Java heap, current MaxHeapSize = "
978 "%zuM", MaxHeapSize/M);
979 AOTMetaspace::writing_error();
980 } else {
981 oop message = java_lang_Throwable::message(PENDING_EXCEPTION);
982 aot_log_error(aot)("%s: %s", PENDING_EXCEPTION->klass()->external_name(),
983 message == nullptr ? "(null)" : java_lang_String::as_utf8_string(message));
984 AOTMetaspace::writing_error(err_msg("Unexpected exception, use -Xlog:aot%s,exceptions=trace for detail",
985 CDSConfig::new_aot_flags_used() ? "" : ",cds"));
986 }
987 }
988
989 if (CDSConfig::new_aot_flags_used()) {
990 if (CDSConfig::is_dumping_preimage_static_archive()) {
991 // We are in the JVM that runs the training run. Continue execution,
992 // so that it can finish all clean-up and return the correct exit
993 // code to the OS.
994 } else {
995 // The JLI launcher only recognizes the "old" -Xshare:dump flag.
996 // When the new -XX:AOTMode=create flag is used, we can't return
997 // to the JLI launcher, as the launcher will fail when trying to
998 // run the main class, which is not what we want.
999 struct stat st;
1000 if (os::stat(AOTCache, &st) != 0) {
1001 tty->print_cr("AOTCache creation failed: %s", AOTCache);
1002 } else {
1003 tty->print_cr("AOTCache creation is complete: %s " INT64_FORMAT " bytes", AOTCache, (int64_t)(st.st_size));
1004 }
1005 vm_direct_exit(0);
1006 }
1007 }
1008 }
1009
1010 #if INCLUDE_CDS_JAVA_HEAP && defined(_LP64)
1011 void AOTMetaspace::adjust_heap_sizes_for_dumping() {
1012 if (!CDSConfig::is_dumping_heap() || UseCompressedOops) {
1013 return;
1014 }
1015 // CDS heap dumping requires all string oops to have an offset
1016 // from the heap bottom that can be encoded in 32-bit.
1017 julong max_heap_size = (julong)(4 * G);
1018
1019 if (MinHeapSize > max_heap_size) {
1020 log_debug(aot)("Setting MinHeapSize to 4G for CDS dumping, original size = %zuM", MinHeapSize/M);
1021 FLAG_SET_ERGO(MinHeapSize, max_heap_size);
1022 }
1023 if (InitialHeapSize > max_heap_size) {
1024 log_debug(aot)("Setting InitialHeapSize to 4G for CDS dumping, original size = %zuM", InitialHeapSize/M);
1025 FLAG_SET_ERGO(InitialHeapSize, max_heap_size);
1026 }
1027 if (MaxHeapSize > max_heap_size) {
1028 log_debug(aot)("Setting MaxHeapSize to 4G for CDS dumping, original size = %zuM", MaxHeapSize/M);
1029 FLAG_SET_ERGO(MaxHeapSize, max_heap_size);
1030 }
1031 }
1032 #endif // INCLUDE_CDS_JAVA_HEAP && _LP64
1033
1034 void AOTMetaspace::get_default_classlist(char* default_classlist, const size_t buf_size) {
1035 const char* filesep = os::file_separator();
1036 jio_snprintf(default_classlist, buf_size, "%s%slib%sclasslist",
1037 Arguments::get_java_home(), filesep, filesep);
1038 }
1039
1040 void AOTMetaspace::load_classes(TRAPS) {
1041 char default_classlist[JVM_MAXPATHLEN];
1042 const char* classlist_path;
1043
1044 get_default_classlist(default_classlist, JVM_MAXPATHLEN);
1045 if (SharedClassListFile == nullptr) {
1046 classlist_path = default_classlist;
1047 } else {
1048 classlist_path = SharedClassListFile;
1049 }
1050
1051 aot_log_info(aot)("Loading classes to share ...");
1052 ClassListParser::parse_classlist(classlist_path,
1053 ClassListParser::_parse_all, CHECK);
1054 if (ExtraSharedClassListFile) {
1055 ClassListParser::parse_classlist(ExtraSharedClassListFile,
1056 ClassListParser::_parse_all, CHECK);
1057 }
1058 if (classlist_path != default_classlist) {
1059 struct stat statbuf;
1060 if (os::stat(default_classlist, &statbuf) == 0) {
1061 // File exists, let's use it.
1062 ClassListParser::parse_classlist(default_classlist,
1063 ClassListParser::_parse_lambda_forms_invokers_only, CHECK);
1064 }
1065 }
1066
1067 // Some classes are used at CDS runtime but are not yet loaded at this point.
1068 // We can perform dummmy calls to these classes at dumptime to ensure they
1069 // are archived.
1070 exercise_runtime_cds_code(CHECK);
1071
1072 aot_log_info(aot)("Loading classes to share: done.");
1073 }
1074
1075 void AOTMetaspace::exercise_runtime_cds_code(TRAPS) {
1076 // Exercise the manifest processing code
1077 const char* dummy = "Manifest-Version: 1.0\n";
1078 CDSProtectionDomain::create_jar_manifest(dummy, strlen(dummy), CHECK);
1079
1080 // Exercise FileSystem and URL code
1081 CDSProtectionDomain::to_file_URL("dummy.jar", Handle(), CHECK);
1082 }
1083
1084 bool AOTMetaspace::preimage_static_archive_dumped() {
1085 assert(CDSConfig::is_dumping_preimage_static_archive(), "Required");
1086 return AtomicAccess::load_acquire(&_preimage_static_archive_dumped) == 1;
1087 }
1088
1089 void AOTMetaspace::dump_static_archive_impl(StaticArchiveBuilder& builder, TRAPS) {
1090 if (CDSConfig::is_dumping_preimage_static_archive()) {
1091 // When dumping to the AOT configuration file ensure this function is only executed once.
1092 // Multiple invocations may happen via JCmd, during VM exit or other means (in the future)
1093 // from different threads and possibly concurrently.
1094 if (AtomicAccess::cmpxchg(&_preimage_static_archive_dumped, 0, 1) != 0) {
1095 return;
1096 }
1097 }
1098
1099 if (CDSConfig::is_dumping_classic_static_archive()) {
1100 // We are running with -Xshare:dump
1101 load_classes(CHECK);
1102
1103 if (SharedArchiveConfigFile) {
1104 log_info(aot)("Reading extra data from %s ...", SharedArchiveConfigFile);
1105 read_extra_data(THREAD, SharedArchiveConfigFile);
1106 log_info(aot)("Reading extra data: done.");
1107 }
1108 }
1109
1110 if (CDSConfig::is_dumping_preimage_static_archive()) {
1111 log_info(aot)("Reading lambda form invokers from JDK default classlist ...");
1112 char default_classlist[JVM_MAXPATHLEN];
1113 get_default_classlist(default_classlist, JVM_MAXPATHLEN);
1114 struct stat statbuf;
1115 if (os::stat(default_classlist, &statbuf) == 0) {
1116 ClassListParser::parse_classlist(default_classlist,
1117 ClassListParser::_parse_lambda_forms_invokers_only, CHECK);
1118 }
1119 }
1120
1121 #if INCLUDE_CDS_JAVA_HEAP
1122 if (CDSConfig::is_dumping_heap()) {
1123 if (!CDSConfig::is_dumping_preimage_static_archive()) {
1124 // A single thread is required for Reference handling and deterministic CDS archive.
1125 // Its's not required for dumping preimage, where References won't be archived and
1126 // determinism is not needed.
1127 assert(CDSConfig::allow_only_single_java_thread(), "Required");
1128 }
1129 if (!HeapShared::is_archived_boot_layer_available(THREAD)) {
1130 report_loading_error("archivedBootLayer not available, disabling full module graph");
1131 CDSConfig::stop_dumping_full_module_graph();
1132 }
1133 // Do this before link_shared_classes(), as the following line may load new classes.
1134 HeapShared::init_for_dumping(CHECK);
1135 }
1136 #endif
1137
1138 if (CDSConfig::is_dumping_final_static_archive()) {
1139 if (ExtraSharedClassListFile) {
1140 log_info(aot)("Loading extra classes from %s ...", ExtraSharedClassListFile);
1141 ClassListParser::parse_classlist(ExtraSharedClassListFile,
1142 ClassListParser::_parse_all, CHECK);
1143 }
1144 }
1145
1146 // Rewrite and link classes
1147 log_info(aot)("Rewriting and linking classes ...");
1148
1149 // Link any classes which got missed. This would happen if we have loaded classes that
1150 // were not explicitly specified in the classlist. E.g., if an interface implemented by class K
1151 // fails verification, all other interfaces that were not specified in the classlist but
1152 // are implemented by K are not verified.
1153 link_shared_classes(CHECK);
1154 log_info(aot)("Rewriting and linking classes: done");
1155 TrainingData::init_dumptime_table(CHECK); // captures TrainingDataSetLocker
1156
1157 if (CDSConfig::is_dumping_regenerated_lambdaform_invokers()) {
1158 LambdaFormInvokers::regenerate_holder_classes(CHECK);
1159 }
1160
1161 #if INCLUDE_CDS_JAVA_HEAP
1162 if (CDSConfig::is_dumping_heap()) {
1163 HeapShared::init_heap_writer();
1164 if (CDSConfig::is_dumping_full_module_graph()) {
1165 ClassLoaderDataShared::ensure_module_entry_tables_exist();
1166 ClassLoaderDataShared::build_tables(CHECK);
1167 HeapShared::prepare_for_archiving(CHECK);
1168 }
1169
1170 AOTReferenceObjSupport::initialize(CHECK);
1171 AOTReferenceObjSupport::stabilize_cached_reference_objects(CHECK);
1172
1173 if (CDSConfig::is_dumping_aot_linked_classes()) {
1174 // java.lang.Class::reflectionFactory cannot be archived yet. We set this field
1175 // to null, and it will be initialized again at runtime.
1176 log_debug(aot)("Resetting Class::reflectionFactory");
1177 TempNewSymbol method_name = SymbolTable::new_symbol("resetArchivedStates");
1178 Symbol* method_sig = vmSymbols::void_method_signature();
1179 JavaValue result(T_VOID);
1180 JavaCalls::call_static(&result, vmClasses::Class_klass(),
1181 method_name, method_sig, CHECK);
1182
1183 // Perhaps there is a way to avoid hard-coding these names here.
1184 // See discussion in JDK-8342481.
1185 }
1186 } else {
1187 log_info(aot)("Not dumping heap, reset CDSConfig::_is_using_optimized_module_handling");
1188 CDSConfig::stop_using_optimized_module_handling();
1189 }
1190 #endif
1191
1192 if (!CDSConfig::is_dumping_preimage_static_archive()) {
1193 if (CDSConfig::is_dumping_final_static_archive()) {
1194 FileMapInfo::free_current_info(); // FIXME: should not free current info
1195 }
1196 open_output_mapinfo();
1197 }
1198
1199 VM_PopulateDumpSharedSpace op(builder, _output_mapinfo);
1200 VMThread::execute(&op);
1201
1202 if (AOTCodeCache::is_on_for_dump() && CDSConfig::is_dumping_final_static_archive()) {
1203 CDSConfig::enable_dumping_aot_code();
1204 {
1205 builder.start_ac_region();
1206 // Write the contents to AOT code region and close AOTCodeCache before packing the region
1207 AOTCodeCache::close();
1208 builder.end_ac_region();
1209 }
1210 CDSConfig::disable_dumping_aot_code();
1211 }
1212
1213 bool status = write_static_archive(&builder, _output_mapinfo, op.mapped_heap_info(), op.streamed_heap_info());
1214 assert(!_output_mapinfo->is_open(), "Must be closed already");
1215 _output_mapinfo = nullptr;
1216 if (status && CDSConfig::is_dumping_preimage_static_archive()) {
1217 tty->print_cr("%s AOTConfiguration recorded: %s",
1218 CDSConfig::has_temp_aot_config_file() ? "Temporary" : "", AOTConfiguration);
1219 if (CDSConfig::is_single_command_training()) {
1220 fork_and_dump_final_static_archive(CHECK);
1221 }
1222 }
1223
1224 if (!status) {
1225 THROW_MSG(vmSymbols::java_io_IOException(), "Encountered error while dumping");
1226 }
1227 }
1228
1229 bool AOTMetaspace::write_static_archive(ArchiveBuilder* builder,
1230 FileMapInfo* map_info,
1231 AOTMappedHeapInfo* mapped_heap_info,
1232 AOTStreamedHeapInfo* streamed_heap_info) {
1233 // relocate the data so that it can be mapped to AOTMetaspace::requested_base_address()
1234 // without runtime relocation.
1235 builder->relocate_to_requested();
1236 if (!map_info->is_open()) {
1237 return false;
1238 }
1239 map_info->prepare_for_writing();
1240 builder->write_archive(map_info, mapped_heap_info, streamed_heap_info);
1241 return true;
1242 }
1243
1244 static void print_java_launcher(outputStream* st) {
1245 st->print("%s%sbin%sjava", Arguments::get_java_home(), os::file_separator(), os::file_separator());
1246 }
1247
1248 static void append_args(GrowableArray<Handle>* args, const char* arg, TRAPS) {
1249 Handle string = java_lang_String::create_from_str(arg, CHECK);
1250 args->append(string);
1251 }
1252
1253 // Pass all options in Arguments::jvm_args_array() to a child JVM process
1254 // using the JAVA_TOOL_OPTIONS environment variable.
1255 static int exec_jvm_with_java_tool_options(const char* java_launcher_path, TRAPS) {
1256 ResourceMark rm(THREAD);
1257 HandleMark hm(THREAD);
1258 GrowableArray<Handle> args;
1259
1260 const char* cp = Arguments::get_appclasspath();
1261 if (cp != nullptr && strlen(cp) > 0 && strcmp(cp, ".") != 0) {
1262 // We cannot use "-cp", because "-cp" is only interpreted by the java launcher,
1263 // and is not interpreter by arguments.cpp when it loads args from JAVA_TOOL_OPTIONS
1264 stringStream ss;
1265 ss.print("-Djava.class.path=");
1266 ss.print_raw(cp);
1267 append_args(&args, ss.freeze(), CHECK_0);
1268 // CDS$ProcessLauncher::execWithJavaToolOptions() must unset CLASSPATH, which has
1269 // a higher priority than -Djava.class.path=
1270 }
1271
1272 // Pass all arguments. These include those from JAVA_TOOL_OPTIONS and _JAVA_OPTIONS.
1273 for (int i = 0; i < Arguments::num_jvm_args(); i++) {
1274 const char* arg = Arguments::jvm_args_array()[i];
1275 if (strstr(arg, "-XX:AOTCacheOutput=") == arg || // arg starts with ...
1276 strstr(arg, "-XX:AOTConfiguration=") == arg ||
1277 strstr(arg, "-XX:AOTMode=") == arg) {
1278 // Filter these out. They wiill be set below.
1279 } else {
1280 append_args(&args, arg, CHECK_0);
1281 }
1282 }
1283
1284 // Note: because we are running in AOTMode=record, JDK_AOT_VM_OPTIONS have not been
1285 // parsed, so they are not in Arguments::jvm_args_array. If JDK_AOT_VM_OPTIONS is in
1286 // the environment, it will be inherited and parsed by the child JVM process
1287 // in Arguments::parse_java_tool_options_environment_variable().
1288 precond(strcmp(AOTMode, "record") == 0);
1289
1290 // We don't pass Arguments::jvm_flags_array(), as those will be added by
1291 // the child process when it loads .hotspotrc
1292
1293 {
1294 // If AOTCacheOutput contains %p, it should have been already substituted with the
1295 // pid of the training process.
1296 stringStream ss;
1297 ss.print("-XX:AOTCacheOutput=");
1298 ss.print_raw(AOTCacheOutput);
1299 append_args(&args, ss.freeze(), CHECK_0);
1300 }
1301 {
1302 // If AOTCacheConfiguration contains %p, it should have been already substituted with the
1303 // pid of the training process.
1304 // If AOTCacheConfiguration was not explicitly specified, it should have been assigned a
1305 // temporary file name.
1306 stringStream ss;
1307 ss.print("-XX:AOTConfiguration=");
1308 ss.print_raw(AOTConfiguration);
1309 append_args(&args, ss.freeze(), CHECK_0);
1310 }
1311
1312 append_args(&args, "-XX:AOTMode=create", CHECK_0);
1313
1314 Symbol* klass_name = SymbolTable::new_symbol("jdk/internal/misc/CDS$ProcessLauncher");
1315 Klass* k = SystemDictionary::resolve_or_fail(klass_name, true, CHECK_0);
1316 Symbol* methodName = SymbolTable::new_symbol("execWithJavaToolOptions");
1317 Symbol* methodSignature = SymbolTable::new_symbol("(Ljava/lang/String;[Ljava/lang/String;)I");
1318
1319 Handle launcher = java_lang_String::create_from_str(java_launcher_path, CHECK_0);
1320 objArrayOop array = oopFactory::new_objArray(vmClasses::String_klass(), args.length(), CHECK_0);
1321 for (int i = 0; i < args.length(); i++) {
1322 array->obj_at_put(i, args.at(i)());
1323 }
1324 objArrayHandle launcher_args(THREAD, array);
1325
1326 // The following call will pass all options inside the JAVA_TOOL_OPTIONS env variable to
1327 // the child process. It will also clear the _JAVA_OPTIONS and CLASSPATH env variables for
1328 // the child process.
1329 //
1330 // Note: the env variables are set only for the child process. They are not changed
1331 // for the current process. See java.lang.ProcessBuilder::environment().
1332 JavaValue result(T_OBJECT);
1333 JavaCallArguments javacall_args(2);
1334 javacall_args.push_oop(launcher);
1335 javacall_args.push_oop(launcher_args);
1336 JavaCalls::call_static(&result,
1337 InstanceKlass::cast(k),
1338 methodName,
1339 methodSignature,
1340 &javacall_args,
1341 CHECK_0);
1342 return result.get_jint();
1343 }
1344
1345 void AOTMetaspace::fork_and_dump_final_static_archive(TRAPS) {
1346 assert(CDSConfig::is_dumping_preimage_static_archive(), "sanity");
1347
1348 ResourceMark rm;
1349 stringStream ss;
1350 print_java_launcher(&ss);
1351 const char* cmd = ss.freeze();
1352 tty->print_cr("Launching child process %s to assemble AOT cache %s using configuration %s", cmd, AOTCacheOutput, AOTConfiguration);
1353 int status = exec_jvm_with_java_tool_options(cmd, CHECK);
1354 if (status != 0) {
1355 log_error(aot)("Child process failed; status = %d", status);
1356 // We leave the temp config file for debugging
1357 } else if (CDSConfig::has_temp_aot_config_file()) {
1358 const char* tmp_config = AOTConfiguration;
1359 // On Windows, need WRITE permission to remove the file.
1360 WINDOWS_ONLY(chmod(tmp_config, _S_IREAD | _S_IWRITE));
1361 status = remove(tmp_config);
1362 if (status != 0) {
1363 log_error(aot)("Failed to remove temporary AOT configuration file %s", tmp_config);
1364 } else {
1365 tty->print_cr("Removed temporary AOT configuration file %s", tmp_config);
1366 }
1367 }
1368 }
1369
1370 // Returns true if the class's status has changed.
1371 bool AOTMetaspace::try_link_class(JavaThread* current, InstanceKlass* ik) {
1372 ExceptionMark em(current);
1373 JavaThread* THREAD = current; // For exception macros.
1374 assert(CDSConfig::is_dumping_archive(), "sanity");
1375
1376 if (ik->in_aot_cache() && !CDSConfig::is_dumping_final_static_archive()) {
1377 assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
1378 return false;
1379 }
1380
1381 if (ik->is_loaded() && !ik->is_linked() && ik->can_be_verified_at_dumptime() &&
1382 !SystemDictionaryShared::has_class_failed_verification(ik)) {
1383 bool saved = BytecodeVerificationLocal;
1384 if (ik->defined_by_other_loaders() && ik->class_loader() == nullptr) {
1385 // The verification decision is based on BytecodeVerificationRemote
1386 // for non-system classes. Since we are using the null classloader
1387 // to load non-system classes for customized class loaders during dumping,
1388 // we need to temporarily change BytecodeVerificationLocal to be the same as
1389 // BytecodeVerificationRemote. Note this can cause the parent system
1390 // classes also being verified. The extra overhead is acceptable during
1391 // dumping.
1392 BytecodeVerificationLocal = BytecodeVerificationRemote;
1393 }
1394 ik->link_class(THREAD);
1395 if (HAS_PENDING_EXCEPTION) {
1396 ResourceMark rm(THREAD);
1397 oop message = java_lang_Throwable::message(current->pending_exception());
1398 aot_log_warning(aot)("Preload Warning: Verification failed for %s because a %s was thrown: %s",
1399 ik->external_name(),
1400 current->pending_exception()->klass()->external_name(),
1401 message == nullptr ? "(no message)" : java_lang_String::as_utf8_string(message));
1402 CLEAR_PENDING_EXCEPTION;
1403 SystemDictionaryShared::set_class_has_failed_verification(ik);
1404 } else {
1405 assert(!SystemDictionaryShared::has_class_failed_verification(ik), "sanity");
1406 ik->compute_has_loops_flag_for_methods();
1407 }
1408 BytecodeVerificationLocal = saved;
1409 return true;
1410 } else {
1411 return false;
1412 }
1413 }
1414
1415 void VM_PopulateDumpSharedSpace::dump_java_heap_objects() {
1416 if (CDSConfig::is_dumping_heap()) {
1417 HeapShared::write_heap(&_mapped_heap_info, &_streamed_heap_info);
1418 } else {
1419 CDSConfig::log_reasons_for_not_dumping_heap();
1420 }
1421 }
1422
1423 void AOTMetaspace::set_aot_metaspace_range(void* base, void *static_top, void* top) {
1424 assert(base <= static_top && static_top <= top, "must be");
1425 _aot_metaspace_static_top = static_top;
1426 MetaspaceObj::set_aot_metaspace_range(base, top);
1427 }
1428
1429 bool AOTMetaspace::in_aot_cache_dynamic_region(void* p) {
1430 if ((p < MetaspaceObj::aot_metaspace_top()) &&
1431 (p >= _aot_metaspace_static_top)) {
1432 return true;
1433 } else {
1434 return false;
1435 }
1436 }
1437
1438 bool AOTMetaspace::in_aot_cache_static_region(void* p) {
1439 if (in_aot_cache(p) && !in_aot_cache_dynamic_region(p)) {
1440 return true;
1441 } else {
1442 return false;
1443 }
1444 }
1445
1446 // This function is called when the JVM is unable to load the specified archive(s) due to one
1447 // of the following conditions.
1448 // - There's an error that indicates that the archive(s) files were corrupt or otherwise damaged.
1449 // - When -XX:+RequireSharedSpaces is specified, AND the JVM cannot load the archive(s) due
1450 // to version or classpath mismatch.
1451 void AOTMetaspace::unrecoverable_loading_error(const char* message) {
1452 report_loading_error("%s", message);
1453
1454 if (CDSConfig::is_dumping_final_static_archive()) {
1455 vm_exit_during_initialization("Must be a valid AOT configuration generated by the current JVM", AOTConfiguration);
1456 } else if (CDSConfig::new_aot_flags_used()) {
1457 vm_exit_during_initialization("Unable to use AOT cache.", nullptr);
1458 } else {
1459 vm_exit_during_initialization("Unable to use shared archive. Unrecoverable archive loading error (run with -Xlog:aot,cds for details)", message);
1460 }
1461 }
1462
1463 void AOTMetaspace::report_loading_error(const char* format, ...) {
1464 // When using AOT cache, errors messages are always printed on the error channel.
1465 LogStream ls_aot(LogLevel::Error, LogTagSetMapping<LOG_TAGS(aot)>::tagset());
1466
1467 // If we are loading load the default CDS archive, it may fail due to incompatible VM options.
1468 // Print at the info level to avoid excessive verbosity.
1469 // However, if the user has specified a CDS archive (or AOT cache), they would be interested in
1470 // knowing that the loading fails, so we print at the error level.
1471 LogLevelType level = (!CDSConfig::is_using_archive() || CDSConfig::is_using_only_default_archive()) ?
1472 LogLevel::Info : LogLevel::Error;
1473 LogStream ls_cds(level, LogTagSetMapping<LOG_TAGS(cds)>::tagset());
1474
1475 LogStream& ls = CDSConfig::new_aot_flags_used() ? ls_aot : ls_cds;
1476 if (!ls.is_enabled()) {
1477 return;
1478 }
1479
1480 va_list ap;
1481 va_start(ap, format);
1482
1483 static bool printed_error = false;
1484 if (!printed_error) { // No need for locks. Loading error checks happen only in main thread.
1485 ls.print_cr("An error has occurred while processing the %s. Run with -Xlog:%s for details.",
1486 CDSConfig::type_of_archive_being_loaded(), CDSConfig::new_aot_flags_used() ? "aot" : "aot,cds");
1487 printed_error = true;
1488 }
1489 ls.vprint_cr(format, ap);
1490
1491 va_end(ap);
1492 }
1493
1494 // This function is called when the JVM is unable to write the specified CDS archive due to an
1495 // unrecoverable error.
1496 void AOTMetaspace::unrecoverable_writing_error(const char* message) {
1497 writing_error(message);
1498 vm_direct_exit(1);
1499 }
1500
1501 // This function is called when the JVM is unable to write the specified CDS archive due to a
1502 // an error. The error will be propagated
1503 void AOTMetaspace::writing_error(const char* message) {
1504 aot_log_error(aot)("An error has occurred while writing the shared archive file.");
1505 if (message != nullptr) {
1506 aot_log_error(aot)("%s", message);
1507 }
1508 }
1509
1510 void AOTMetaspace::initialize_runtime_shared_and_meta_spaces() {
1511 assert(CDSConfig::is_using_archive(), "Must be called when UseSharedSpaces is enabled");
1512 MapArchiveResult result = MAP_ARCHIVE_OTHER_FAILURE;
1513
1514 FileMapInfo* static_mapinfo = open_static_archive();
1515 FileMapInfo* dynamic_mapinfo = nullptr;
1516
1517 if (static_mapinfo != nullptr) {
1518 aot_log_info(aot)("Core region alignment: %zu", static_mapinfo->core_region_alignment());
1519 dynamic_mapinfo = open_dynamic_archive();
1520
1521 aot_log_info(aot)("ArchiveRelocationMode: %d", ArchiveRelocationMode);
1522
1523 // First try to map at the requested address
1524 result = map_archives(static_mapinfo, dynamic_mapinfo, true);
1525 if (result == MAP_ARCHIVE_MMAP_FAILURE) {
1526 // Mapping has failed (probably due to ASLR). Let's map at an address chosen
1527 // by the OS.
1528 aot_log_info(aot)("Try to map archive(s) at an alternative address");
1529 result = map_archives(static_mapinfo, dynamic_mapinfo, false);
1530 }
1531 }
1532
1533 if (result == MAP_ARCHIVE_SUCCESS) {
1534 bool dynamic_mapped = (dynamic_mapinfo != nullptr && dynamic_mapinfo->is_mapped());
1535 char* cds_base = static_mapinfo->mapped_base();
1536 char* cds_end = dynamic_mapped ? dynamic_mapinfo->mapped_end() : static_mapinfo->mapped_end();
1537 // Register CDS memory region with LSan.
1538 LSAN_REGISTER_ROOT_REGION(cds_base, cds_end - cds_base);
1539 set_aot_metaspace_range(cds_base, static_mapinfo->mapped_end(), cds_end);
1540 _relocation_delta = static_mapinfo->relocation_delta();
1541 _requested_base_address = static_mapinfo->requested_base_address();
1542 if (dynamic_mapped) {
1543 // turn AutoCreateSharedArchive off if successfully mapped
1544 AutoCreateSharedArchive = false;
1545 }
1546 } else {
1547 set_aot_metaspace_range(nullptr, nullptr, nullptr);
1548 if (CDSConfig::is_dumping_dynamic_archive()) {
1549 aot_log_warning(aot)("-XX:ArchiveClassesAtExit is unsupported when base CDS archive is not loaded. Run with -Xlog:cds for more info.");
1550 }
1551 UseSharedSpaces = false;
1552 // The base archive cannot be mapped. We cannot dump the dynamic shared archive.
1553 AutoCreateSharedArchive = false;
1554 CDSConfig::disable_dumping_dynamic_archive();
1555 if (PrintSharedArchiveAndExit) {
1556 AOTMetaspace::unrecoverable_loading_error("Unable to use shared archive.");
1557 } else {
1558 if (RequireSharedSpaces) {
1559 AOTMetaspace::unrecoverable_loading_error("Unable to map shared spaces");
1560 } else {
1561 report_loading_error("Unable to map shared spaces");
1562 }
1563 }
1564 }
1565
1566 // If mapping failed and -XShare:on, the vm should exit
1567 bool has_failed = false;
1568 if (static_mapinfo != nullptr && !static_mapinfo->is_mapped()) {
1569 has_failed = true;
1570 delete static_mapinfo;
1571 }
1572 if (dynamic_mapinfo != nullptr && !dynamic_mapinfo->is_mapped()) {
1573 has_failed = true;
1574 delete dynamic_mapinfo;
1575 }
1576 if (RequireSharedSpaces && has_failed) {
1577 AOTMetaspace::unrecoverable_loading_error("Unable to map shared spaces");
1578 }
1579 }
1580
1581 FileMapInfo* AOTMetaspace::open_static_archive() {
1582 const char* static_archive = CDSConfig::input_static_archive_path();
1583 assert(static_archive != nullptr, "sanity");
1584 FileMapInfo* mapinfo = new FileMapInfo(static_archive, true);
1585 if (!mapinfo->open_as_input()) {
1586 delete(mapinfo);
1587 log_info(cds)("Opening of static archive %s failed", static_archive);
1588 return nullptr;
1589 }
1590 return mapinfo;
1591 }
1592
1593 FileMapInfo* AOTMetaspace::open_dynamic_archive() {
1594 if (CDSConfig::is_dumping_dynamic_archive()) {
1595 return nullptr;
1596 }
1597 const char* dynamic_archive = CDSConfig::input_dynamic_archive_path();
1598 if (dynamic_archive == nullptr) {
1599 return nullptr;
1600 }
1601
1602 FileMapInfo* mapinfo = new FileMapInfo(dynamic_archive, false);
1603 if (!mapinfo->open_as_input()) {
1604 delete(mapinfo);
1605 if (RequireSharedSpaces) {
1606 AOTMetaspace::unrecoverable_loading_error("Failed to initialize dynamic archive");
1607 }
1608 return nullptr;
1609 }
1610 return mapinfo;
1611 }
1612
1613 // use_requested_addr:
1614 // true = map at FileMapHeader::_requested_base_address
1615 // false = map at an alternative address picked by OS.
1616 MapArchiveResult AOTMetaspace::map_archives(FileMapInfo* static_mapinfo, FileMapInfo* dynamic_mapinfo,
1617 bool use_requested_addr) {
1618 if (use_requested_addr && static_mapinfo->requested_base_address() == nullptr) {
1619 aot_log_info(aot)("Archive(s) were created with -XX:SharedBaseAddress=0. Always map at os-selected address.");
1620 return MAP_ARCHIVE_MMAP_FAILURE;
1621 }
1622
1623 PRODUCT_ONLY(if (ArchiveRelocationMode == 1 && use_requested_addr) {
1624 // For product build only -- this is for benchmarking the cost of doing relocation.
1625 // For debug builds, the check is done below, after reserving the space, for better test coverage
1626 // (see comment below).
1627 aot_log_info(aot)("ArchiveRelocationMode == 1: always map archive(s) at an alternative address");
1628 return MAP_ARCHIVE_MMAP_FAILURE;
1629 });
1630
1631 if (ArchiveRelocationMode == 2 && !use_requested_addr) {
1632 aot_log_info(aot)("ArchiveRelocationMode == 2: never map archive(s) at an alternative address");
1633 return MAP_ARCHIVE_MMAP_FAILURE;
1634 };
1635
1636 if (dynamic_mapinfo != nullptr) {
1637 // Ensure that the OS won't be able to allocate new memory spaces between the two
1638 // archives, or else it would mess up the simple comparison in MetaspaceObj::in_aot_cache().
1639 assert(static_mapinfo->mapping_end_offset() == dynamic_mapinfo->mapping_base_offset(), "no gap");
1640 }
1641
1642 ReservedSpace total_space_rs, archive_space_rs, class_space_rs;
1643 MapArchiveResult result = MAP_ARCHIVE_OTHER_FAILURE;
1644 size_t prot_zone_size = 0;
1645 char* mapped_base_address = reserve_address_space_for_archives(static_mapinfo,
1646 dynamic_mapinfo,
1647 use_requested_addr,
1648 total_space_rs,
1649 archive_space_rs,
1650 class_space_rs);
1651 if (mapped_base_address == nullptr) {
1652 result = MAP_ARCHIVE_MMAP_FAILURE;
1653 aot_log_debug(aot)("Failed to reserve spaces (use_requested_addr=%u)", (unsigned)use_requested_addr);
1654 } else {
1655
1656 if (Metaspace::using_class_space()) {
1657 prot_zone_size = protection_zone_size();
1658 }
1659
1660 #ifdef ASSERT
1661 // Some sanity checks after reserving address spaces for archives
1662 // and class space.
1663 assert(archive_space_rs.is_reserved(), "Sanity");
1664 if (Metaspace::using_class_space()) {
1665 assert(archive_space_rs.base() == mapped_base_address &&
1666 archive_space_rs.size() > protection_zone_size(),
1667 "Archive space must lead and include the protection zone");
1668 // Class space must closely follow the archive space. Both spaces
1669 // must be aligned correctly.
1670 assert(class_space_rs.is_reserved() && class_space_rs.size() > 0,
1671 "A class space should have been reserved");
1672 assert(class_space_rs.base() >= archive_space_rs.end(),
1673 "class space should follow the cds archive space");
1674 assert(is_aligned(archive_space_rs.base(),
1675 core_region_alignment()),
1676 "Archive space misaligned");
1677 assert(is_aligned(class_space_rs.base(),
1678 Metaspace::reserve_alignment()),
1679 "class space misaligned");
1680 }
1681 #endif // ASSERT
1682
1683 aot_log_info(aot)("Reserved archive_space_rs [" INTPTR_FORMAT " - " INTPTR_FORMAT "] (%zu) bytes%s",
1684 p2i(archive_space_rs.base()), p2i(archive_space_rs.end()), archive_space_rs.size(),
1685 (prot_zone_size > 0 ? " (includes protection zone)" : ""));
1686 aot_log_info(aot)("Reserved class_space_rs [" INTPTR_FORMAT " - " INTPTR_FORMAT "] (%zu) bytes",
1687 p2i(class_space_rs.base()), p2i(class_space_rs.end()), class_space_rs.size());
1688
1689 if (AOTMetaspace::use_windows_memory_mapping()) {
1690 // We have now reserved address space for the archives, and will map in
1691 // the archive files into this space.
1692 //
1693 // Special handling for Windows: on Windows we cannot map a file view
1694 // into an existing memory mapping. So, we unmap the address range we
1695 // just reserved again, which will make it available for mapping the
1696 // archives.
1697 // Reserving this range has not been for naught however since it makes
1698 // us reasonably sure the address range is available.
1699 //
1700 // But still it may fail, since between unmapping the range and mapping
1701 // in the archive someone else may grab the address space. Therefore
1702 // there is a fallback in FileMap::map_region() where we just read in
1703 // the archive files sequentially instead of mapping it in. We couple
1704 // this with use_requested_addr, since we're going to patch all the
1705 // pointers anyway so there's no benefit to mmap.
1706 if (use_requested_addr) {
1707 assert(!total_space_rs.is_reserved(), "Should not be reserved for Windows");
1708 aot_log_info(aot)("Windows mmap workaround: releasing archive space.");
1709 MemoryReserver::release(archive_space_rs);
1710 // Mark as not reserved
1711 archive_space_rs = {};
1712 // The protection zone is part of the archive:
1713 // See comment above, the Windows way of loading CDS is to mmap the individual
1714 // parts of the archive into the address region we just vacated. The protection
1715 // zone will not be mapped (and, in fact, does not exist as physical region in
1716 // the archive). Therefore, after removing the archive space above, we must
1717 // re-reserve the protection zone part lest something else gets mapped into that
1718 // area later.
1719 if (prot_zone_size > 0) {
1720 assert(prot_zone_size >= os::vm_allocation_granularity(), "must be"); // not just page size!
1721 char* p = os::attempt_reserve_memory_at(mapped_base_address, prot_zone_size,
1722 mtClassShared);
1723 assert(p == mapped_base_address || p == nullptr, "must be");
1724 if (p == nullptr) {
1725 aot_log_debug(aot)("Failed to re-reserve protection zone");
1726 return MAP_ARCHIVE_MMAP_FAILURE;
1727 }
1728 }
1729 }
1730 }
1731
1732 if (prot_zone_size > 0) {
1733 os::commit_memory(mapped_base_address, prot_zone_size, false); // will later be protected
1734 // Before mapping the core regions into the newly established address space, we mark
1735 // start and the end of the future protection zone with canaries. That way we easily
1736 // catch mapping errors (accidentally mapping data into the future protection zone).
1737 *(mapped_base_address) = 'P';
1738 *(mapped_base_address + prot_zone_size - 1) = 'P';
1739 }
1740
1741 MapArchiveResult static_result = map_archive(static_mapinfo, mapped_base_address, archive_space_rs);
1742 MapArchiveResult dynamic_result = (static_result == MAP_ARCHIVE_SUCCESS) ?
1743 map_archive(dynamic_mapinfo, mapped_base_address, archive_space_rs) : MAP_ARCHIVE_OTHER_FAILURE;
1744
1745 DEBUG_ONLY(if (ArchiveRelocationMode == 1 && use_requested_addr) {
1746 // This is for simulating mmap failures at the requested address. In
1747 // debug builds, we do it here (after all archives have possibly been
1748 // mapped), so we can thoroughly test the code for failure handling
1749 // (releasing all allocated resource, etc).
1750 aot_log_info(aot)("ArchiveRelocationMode == 1: always map archive(s) at an alternative address");
1751 if (static_result == MAP_ARCHIVE_SUCCESS) {
1752 static_result = MAP_ARCHIVE_MMAP_FAILURE;
1753 }
1754 if (dynamic_result == MAP_ARCHIVE_SUCCESS) {
1755 dynamic_result = MAP_ARCHIVE_MMAP_FAILURE;
1756 }
1757 });
1758
1759 if (static_result == MAP_ARCHIVE_SUCCESS) {
1760 if (dynamic_result == MAP_ARCHIVE_SUCCESS) {
1761 result = MAP_ARCHIVE_SUCCESS;
1762 } else if (dynamic_result == MAP_ARCHIVE_OTHER_FAILURE) {
1763 assert(dynamic_mapinfo != nullptr && !dynamic_mapinfo->is_mapped(), "must have failed");
1764 // No need to retry mapping the dynamic archive again, as it will never succeed
1765 // (bad file, etc) -- just keep the base archive.
1766 log_warning(cds, dynamic)("Unable to use shared archive. The top archive failed to load: %s",
1767 dynamic_mapinfo->full_path());
1768 result = MAP_ARCHIVE_SUCCESS;
1769 // TODO, we can give the unused space for the dynamic archive to class_space_rs, but there's no
1770 // easy API to do that right now.
1771 } else {
1772 result = MAP_ARCHIVE_MMAP_FAILURE;
1773 }
1774 } else if (static_result == MAP_ARCHIVE_OTHER_FAILURE) {
1775 result = MAP_ARCHIVE_OTHER_FAILURE;
1776 } else {
1777 result = MAP_ARCHIVE_MMAP_FAILURE;
1778 }
1779 }
1780
1781 if (result == MAP_ARCHIVE_SUCCESS) {
1782 SharedBaseAddress = (size_t)mapped_base_address;
1783 #ifdef _LP64
1784 if (Metaspace::using_class_space()) {
1785 assert(prot_zone_size > 0 &&
1786 *(mapped_base_address) == 'P' &&
1787 *(mapped_base_address + prot_zone_size - 1) == 'P',
1788 "Protection zone was overwritten?");
1789 // Set up ccs in metaspace.
1790 Metaspace::initialize_class_space(class_space_rs);
1791
1792 // Set up compressed Klass pointer encoding: the encoding range must
1793 // cover both archive and class space.
1794 const address klass_range_start = (address)mapped_base_address;
1795 const size_t klass_range_size = (address)class_space_rs.end() - klass_range_start;
1796 if (INCLUDE_CDS_JAVA_HEAP || UseCompactObjectHeaders) {
1797 // The CDS archive may contain narrow Klass IDs that were precomputed at archive generation time:
1798 // - every archived java object header (only if INCLUDE_CDS_JAVA_HEAP)
1799 // - every archived Klass' prototype (only if +UseCompactObjectHeaders)
1800 //
1801 // In order for those IDs to still be valid, we need to dictate base and shift: base should be the
1802 // mapping start (including protection zone), shift should be the shift used at archive generation time.
1803 CompressedKlassPointers::initialize_for_given_encoding(
1804 klass_range_start, klass_range_size,
1805 klass_range_start, ArchiveBuilder::precomputed_narrow_klass_shift() // precomputed encoding, see ArchiveBuilder
1806 );
1807 assert(CompressedKlassPointers::base() == klass_range_start, "must be");
1808 } else {
1809 // Let JVM freely choose encoding base and shift
1810 CompressedKlassPointers::initialize(klass_range_start, klass_range_size);
1811 assert(CompressedKlassPointers::base() == nullptr ||
1812 CompressedKlassPointers::base() == klass_range_start, "must be");
1813 }
1814 // Establish protection zone, but only if we need one
1815 if (CompressedKlassPointers::base() == klass_range_start) {
1816 CompressedKlassPointers::establish_protection_zone(klass_range_start, prot_zone_size);
1817 }
1818
1819 if (static_mapinfo->can_use_heap_region()) {
1820 if (static_mapinfo->object_streaming_mode()) {
1821 HeapShared::initialize_loading_mode(HeapArchiveMode::_streaming);
1822 } else {
1823 // map_or_load_heap_region() compares the current narrow oop and klass encodings
1824 // with the archived ones, so it must be done after all encodings are determined.
1825 static_mapinfo->map_or_load_heap_region();
1826 HeapShared::initialize_loading_mode(HeapArchiveMode::_mapping);
1827 }
1828 } else {
1829 FileMapRegion* r = static_mapinfo->region_at(AOTMetaspace::hp);
1830 if (r->used() > 0) {
1831 if (static_mapinfo->object_streaming_mode()) {
1832 AOTMetaspace::report_loading_error("Cannot use CDS heap data.");
1833 } else {
1834 if (!UseCompressedOops && !AOTMappedHeapLoader::can_map()) {
1835 AOTMetaspace::report_loading_error("Cannot use CDS heap data. Selected GC not compatible -XX:-UseCompressedOops");
1836 } else {
1837 AOTMetaspace::report_loading_error("Cannot use CDS heap data. UseEpsilonGC, UseG1GC, UseSerialGC, UseParallelGC, or UseShenandoahGC are required.");
1838 }
1839 }
1840 }
1841 }
1842 }
1843 #endif // _LP64
1844 log_info(aot)("initial optimized module handling: %s", CDSConfig::is_using_optimized_module_handling() ? "enabled" : "disabled");
1845 log_info(aot)("initial full module graph: %s", CDSConfig::is_using_full_module_graph() ? "enabled" : "disabled");
1846 } else {
1847 unmap_archive(static_mapinfo);
1848 unmap_archive(dynamic_mapinfo);
1849 release_reserved_spaces(total_space_rs, archive_space_rs, class_space_rs);
1850 }
1851
1852 return result;
1853 }
1854
1855
1856 // This will reserve two address spaces suitable to house Klass structures, one
1857 // for the cds archives (static archive and optionally dynamic archive) and
1858 // optionally one move for ccs.
1859 //
1860 // Since both spaces must fall within the compressed class pointer encoding
1861 // range, they are allocated close to each other.
1862 //
1863 // Space for archives will be reserved first, followed by a potential gap,
1864 // followed by the space for ccs:
1865 //
1866 // +-- Base address A B End
1867 // | | | |
1868 // v v v v
1869 // +-------------+--------------+ +----------------------+
1870 // | static arc | [dyn. arch] | [gap] | compr. class space |
1871 // +-------------+--------------+ +----------------------+
1872 //
1873 // (The gap may result from different alignment requirements between metaspace
1874 // and CDS)
1875 //
1876 // If UseCompressedClassPointers is disabled, only one address space will be
1877 // reserved:
1878 //
1879 // +-- Base address End
1880 // | |
1881 // v v
1882 // +-------------+--------------+
1883 // | static arc | [dyn. arch] |
1884 // +-------------+--------------+
1885 //
1886 // Base address: If use_archive_base_addr address is true, the Base address is
1887 // determined by the address stored in the static archive. If
1888 // use_archive_base_addr address is false, this base address is determined
1889 // by the platform.
1890 //
1891 // If UseCompressedClassPointers=1, the range encompassing both spaces will be
1892 // suitable to en/decode narrow Klass pointers: the base will be valid for
1893 // encoding, the range [Base, End) and not surpass the max. range for that encoding.
1894 //
1895 // Return:
1896 //
1897 // - On success:
1898 // - total_space_rs will be reserved as whole for archive_space_rs and
1899 // class_space_rs if UseCompressedClassPointers is true.
1900 // On Windows, try reserve archive_space_rs and class_space_rs
1901 // separately first if use_archive_base_addr is true.
1902 // - archive_space_rs will be reserved and large enough to host static and
1903 // if needed dynamic archive: [Base, A).
1904 // archive_space_rs.base and size will be aligned to CDS reserve
1905 // granularity.
1906 // - class_space_rs: If UseCompressedClassPointers=1, class_space_rs will
1907 // be reserved. Its start address will be aligned to metaspace reserve
1908 // alignment, which may differ from CDS alignment. It will follow the cds
1909 // archive space, close enough such that narrow class pointer encoding
1910 // covers both spaces.
1911 // If UseCompressedClassPointers=0, class_space_rs remains unreserved.
1912 // - On error: null is returned and the spaces remain unreserved.
1913 char* AOTMetaspace::reserve_address_space_for_archives(FileMapInfo* static_mapinfo,
1914 FileMapInfo* dynamic_mapinfo,
1915 bool use_archive_base_addr,
1916 ReservedSpace& total_space_rs,
1917 ReservedSpace& archive_space_rs,
1918 ReservedSpace& class_space_rs) {
1919
1920 address const base_address = (address) (use_archive_base_addr ? static_mapinfo->requested_base_address() : nullptr);
1921 const size_t archive_space_alignment = core_region_alignment();
1922
1923 // Size and requested location of the archive_space_rs (for both static and dynamic archives)
1924 size_t archive_end_offset = (dynamic_mapinfo == nullptr) ? static_mapinfo->mapping_end_offset() : dynamic_mapinfo->mapping_end_offset();
1925 size_t archive_space_size = align_up(archive_end_offset, archive_space_alignment);
1926
1927 if (!Metaspace::using_class_space()) {
1928 // Get the simple case out of the way first:
1929 // no compressed class space, simple allocation.
1930
1931 // When running without class space, requested archive base should be aligned to cds core alignment.
1932 assert(is_aligned(base_address, archive_space_alignment),
1933 "Archive base address unaligned: " PTR_FORMAT ", needs alignment: %zu.",
1934 p2i(base_address), archive_space_alignment);
1935
1936 archive_space_rs = MemoryReserver::reserve((char*)base_address,
1937 archive_space_size,
1938 archive_space_alignment,
1939 os::vm_page_size(),
1940 mtNone);
1941 if (archive_space_rs.is_reserved()) {
1942 assert(base_address == nullptr ||
1943 (address)archive_space_rs.base() == base_address, "Sanity");
1944 // Register archive space with NMT.
1945 MemTracker::record_virtual_memory_tag(archive_space_rs, mtClassShared);
1946 return archive_space_rs.base();
1947 }
1948 return nullptr;
1949 }
1950
1951 #ifdef _LP64
1952
1953 // Complex case: two spaces adjacent to each other, both to be addressable
1954 // with narrow class pointers.
1955 // We reserve the whole range spanning both spaces, then split that range up.
1956
1957 const size_t class_space_alignment = Metaspace::reserve_alignment();
1958
1959 // When running with class space, requested archive base must satisfy both cds core alignment
1960 // and class space alignment.
1961 const size_t base_address_alignment = MAX2(class_space_alignment, archive_space_alignment);
1962 assert(is_aligned(base_address, base_address_alignment),
1963 "Archive base address unaligned: " PTR_FORMAT ", needs alignment: %zu.",
1964 p2i(base_address), base_address_alignment);
1965
1966 size_t class_space_size = CompressedClassSpaceSize;
1967 assert(CompressedClassSpaceSize > 0 &&
1968 is_aligned(CompressedClassSpaceSize, class_space_alignment),
1969 "CompressedClassSpaceSize malformed: %zu", CompressedClassSpaceSize);
1970
1971 const size_t ccs_begin_offset = align_up(archive_space_size, class_space_alignment);
1972 const size_t gap_size = ccs_begin_offset - archive_space_size;
1973
1974 // Reduce class space size if it would not fit into the Klass encoding range
1975 constexpr size_t max_encoding_range_size = 4 * G;
1976 guarantee(archive_space_size < max_encoding_range_size - class_space_alignment, "Archive too large");
1977 if ((archive_space_size + gap_size + class_space_size) > max_encoding_range_size) {
1978 class_space_size = align_down(max_encoding_range_size - archive_space_size - gap_size, class_space_alignment);
1979 log_info(metaspace)("CDS initialization: reducing class space size from %zu to %zu",
1980 CompressedClassSpaceSize, class_space_size);
1981 FLAG_SET_ERGO(CompressedClassSpaceSize, class_space_size);
1982 }
1983
1984 const size_t total_range_size =
1985 archive_space_size + gap_size + class_space_size;
1986
1987 // Test that class space base address plus shift can be decoded by aarch64, when restored.
1988 const int precomputed_narrow_klass_shift = ArchiveBuilder::precomputed_narrow_klass_shift();
1989 if (!CompressedKlassPointers::check_klass_decode_mode(base_address, precomputed_narrow_klass_shift,
1990 total_range_size)) {
1991 aot_log_info(aot)("CDS initialization: Cannot use SharedBaseAddress " PTR_FORMAT " with precomputed shift %d.",
1992 p2i(base_address), precomputed_narrow_klass_shift);
1993 use_archive_base_addr = false;
1994 }
1995
1996 assert(total_range_size > ccs_begin_offset, "must be");
1997 if (use_windows_memory_mapping() && use_archive_base_addr) {
1998 if (base_address != nullptr) {
1999 // On Windows, we cannot safely split a reserved memory space into two (see JDK-8255917).
2000 // Hence, we optimistically reserve archive space and class space side-by-side. We only
2001 // do this for use_archive_base_addr=true since for use_archive_base_addr=false case
2002 // caller will not split the combined space for mapping, instead read the archive data
2003 // via sequential file IO.
2004 address ccs_base = base_address + archive_space_size + gap_size;
2005 archive_space_rs = MemoryReserver::reserve((char*)base_address,
2006 archive_space_size,
2007 archive_space_alignment,
2008 os::vm_page_size(),
2009 mtNone);
2010 class_space_rs = MemoryReserver::reserve((char*)ccs_base,
2011 class_space_size,
2012 class_space_alignment,
2013 os::vm_page_size(),
2014 mtNone);
2015 }
2016 if (!archive_space_rs.is_reserved() || !class_space_rs.is_reserved()) {
2017 release_reserved_spaces(total_space_rs, archive_space_rs, class_space_rs);
2018 return nullptr;
2019 }
2020 MemTracker::record_virtual_memory_tag(archive_space_rs, mtClassShared);
2021 MemTracker::record_virtual_memory_tag(class_space_rs, mtClass);
2022 } else {
2023 if (use_archive_base_addr && base_address != nullptr) {
2024 total_space_rs = MemoryReserver::reserve((char*) base_address,
2025 total_range_size,
2026 base_address_alignment,
2027 os::vm_page_size(),
2028 mtNone);
2029 } else {
2030 // We did not manage to reserve at the preferred address, or were instructed to relocate. In that
2031 // case we reserve wherever possible, but the start address needs to be encodable as narrow Klass
2032 // encoding base since the archived heap objects contain narrow Klass IDs pre-calculated toward the start
2033 // of the shared Metaspace. That prevents us from using zero-based encoding and therefore we won't
2034 // try allocating in low-address regions.
2035 total_space_rs = Metaspace::reserve_address_space_for_compressed_classes(total_range_size, false /* optimize_for_zero_base */);
2036 }
2037
2038 if (!total_space_rs.is_reserved()) {
2039 return nullptr;
2040 }
2041
2042 // Paranoid checks:
2043 assert(!use_archive_base_addr || (address)total_space_rs.base() == base_address,
2044 "Sanity (" PTR_FORMAT " vs " PTR_FORMAT ")", p2i(base_address), p2i(total_space_rs.base()));
2045 assert(is_aligned(total_space_rs.base(), base_address_alignment), "Sanity");
2046 assert(total_space_rs.size() == total_range_size, "Sanity");
2047
2048 // Now split up the space into ccs and cds archive. For simplicity, just leave
2049 // the gap reserved at the end of the archive space. Do not do real splitting.
2050 archive_space_rs = total_space_rs.first_part(ccs_begin_offset,
2051 (size_t)archive_space_alignment);
2052 class_space_rs = total_space_rs.last_part(ccs_begin_offset);
2053 MemTracker::record_virtual_memory_split_reserved(total_space_rs.base(), total_space_rs.size(),
2054 ccs_begin_offset, mtClassShared, mtClass);
2055 }
2056 assert(is_aligned(archive_space_rs.base(), archive_space_alignment), "Sanity");
2057 assert(is_aligned(archive_space_rs.size(), archive_space_alignment), "Sanity");
2058 assert(is_aligned(class_space_rs.base(), class_space_alignment), "Sanity");
2059 assert(is_aligned(class_space_rs.size(), class_space_alignment), "Sanity");
2060
2061
2062 return archive_space_rs.base();
2063
2064 #else
2065 ShouldNotReachHere();
2066 return nullptr;
2067 #endif
2068
2069 }
2070
2071 void AOTMetaspace::release_reserved_spaces(ReservedSpace& total_space_rs,
2072 ReservedSpace& archive_space_rs,
2073 ReservedSpace& class_space_rs) {
2074 if (total_space_rs.is_reserved()) {
2075 aot_log_debug(aot)("Released shared space (archive + class) " INTPTR_FORMAT, p2i(total_space_rs.base()));
2076 MemoryReserver::release(total_space_rs);
2077 total_space_rs = {};
2078 } else {
2079 if (archive_space_rs.is_reserved()) {
2080 aot_log_debug(aot)("Released shared space (archive) " INTPTR_FORMAT, p2i(archive_space_rs.base()));
2081 MemoryReserver::release(archive_space_rs);
2082 archive_space_rs = {};
2083 }
2084 if (class_space_rs.is_reserved()) {
2085 aot_log_debug(aot)("Released shared space (classes) " INTPTR_FORMAT, p2i(class_space_rs.base()));
2086 MemoryReserver::release(class_space_rs);
2087 class_space_rs = {};
2088 }
2089 }
2090 }
2091
2092 static int archive_regions[] = { AOTMetaspace::rw, AOTMetaspace::ro };
2093 static int archive_regions_count = 2;
2094
2095 MapArchiveResult AOTMetaspace::map_archive(FileMapInfo* mapinfo, char* mapped_base_address, ReservedSpace rs) {
2096 assert(CDSConfig::is_using_archive(), "must be runtime");
2097 if (mapinfo == nullptr) {
2098 return MAP_ARCHIVE_SUCCESS; // The dynamic archive has not been specified. No error has happened -- trivially succeeded.
2099 }
2100
2101 mapinfo->set_is_mapped(false);
2102 if (mapinfo->core_region_alignment() != (size_t)core_region_alignment()) {
2103 report_loading_error("Unable to map CDS archive -- core_region_alignment() expected: %zu"
2104 " actual: %zu", mapinfo->core_region_alignment(), core_region_alignment());
2105 return MAP_ARCHIVE_OTHER_FAILURE;
2106 }
2107
2108 MapArchiveResult result =
2109 mapinfo->map_regions(archive_regions, archive_regions_count, mapped_base_address, rs);
2110
2111 if (result != MAP_ARCHIVE_SUCCESS) {
2112 unmap_archive(mapinfo);
2113 return result;
2114 }
2115
2116 if (!mapinfo->validate_class_location()) {
2117 unmap_archive(mapinfo);
2118 return MAP_ARCHIVE_OTHER_FAILURE;
2119 }
2120
2121 if (mapinfo->is_static()) {
2122 // Currently, only static archive uses early serialized data.
2123 char* buffer = mapinfo->early_serialized_data();
2124 intptr_t* array = (intptr_t*)buffer;
2125 ReadClosure rc(&array, (address)mapped_base_address);
2126 early_serialize(&rc);
2127 }
2128
2129 if (!mapinfo->validate_aot_class_linking()) {
2130 unmap_archive(mapinfo);
2131 return MAP_ARCHIVE_OTHER_FAILURE;
2132 }
2133
2134 mapinfo->set_is_mapped(true);
2135 return MAP_ARCHIVE_SUCCESS;
2136 }
2137
2138 void AOTMetaspace::unmap_archive(FileMapInfo* mapinfo) {
2139 assert(CDSConfig::is_using_archive(), "must be runtime");
2140 if (mapinfo != nullptr) {
2141 mapinfo->unmap_regions(archive_regions, archive_regions_count);
2142 mapinfo->unmap_region(AOTMetaspace::bm);
2143 mapinfo->set_is_mapped(false);
2144 }
2145 }
2146
2147 // For -XX:PrintSharedArchiveAndExit
2148 class CountSharedSymbols : public SymbolClosure {
2149 private:
2150 size_t _count;
2151 public:
2152 CountSharedSymbols() : _count(0) {}
2153 void do_symbol(Symbol** sym) {
2154 _count++;
2155 }
2156 size_t total() { return _count; }
2157
2158 };
2159
2160 // Read the miscellaneous data from the shared file, and
2161 // serialize it out to its various destinations.
2162
2163 void AOTMetaspace::initialize_shared_spaces() {
2164 FileMapInfo *static_mapinfo = FileMapInfo::current_info();
2165 FileMapInfo *dynamic_mapinfo = FileMapInfo::dynamic_info();
2166
2167 // Verify various attributes of the archive, plus initialize the
2168 // shared string/symbol tables.
2169 char* buffer = static_mapinfo->serialized_data();
2170 intptr_t* array = (intptr_t*)buffer;
2171 ReadClosure rc(&array, (address)SharedBaseAddress);
2172 serialize(&rc);
2173
2174 // Finish initializing the heap dump mode used in the archive
2175 // Heap initialization can be done only after vtables are initialized by ReadClosure.
2176 HeapShared::finalize_initialization(static_mapinfo);
2177 Universe::load_archived_object_instances();
2178
2179 AOTCodeCache::initialize();
2180
2181 if (dynamic_mapinfo != nullptr) {
2182 intptr_t* buffer = (intptr_t*)dynamic_mapinfo->serialized_data();
2183 ReadClosure rc(&buffer, (address)SharedBaseAddress);
2184 DynamicArchive::serialize(&rc);
2185 }
2186
2187 LogStreamHandle(Info, aot) lsh;
2188 if (lsh.is_enabled()) {
2189 lsh.print("Using AOT-linked classes: %s (static archive: %s aot-linked classes",
2190 BOOL_TO_STR(CDSConfig::is_using_aot_linked_classes()),
2191 static_mapinfo->header()->has_aot_linked_classes() ? "has" : "no");
2192 if (dynamic_mapinfo != nullptr) {
2193 lsh.print(", dynamic archive: %s aot-linked classes",
2194 dynamic_mapinfo->header()->has_aot_linked_classes() ? "has" : "no");
2195 }
2196 lsh.print_cr(")");
2197 }
2198
2199 // Set up LambdaFormInvokers::_lambdaform_lines for dynamic dump
2200 if (CDSConfig::is_dumping_dynamic_archive()) {
2201 // Read stored LF format lines stored in static archive
2202 LambdaFormInvokers::read_static_archive_invokers();
2203 }
2204
2205 if (PrintSharedArchiveAndExit) {
2206 // Print archive names
2207 if (dynamic_mapinfo != nullptr) {
2208 tty->print_cr("\n\nBase archive name: %s", CDSConfig::input_static_archive_path());
2209 tty->print_cr("Base archive version %d", static_mapinfo->version());
2210 } else {
2211 tty->print_cr("Static archive name: %s", static_mapinfo->full_path());
2212 tty->print_cr("Static archive version %d", static_mapinfo->version());
2213 }
2214
2215 SystemDictionaryShared::print_shared_archive(tty);
2216 if (dynamic_mapinfo != nullptr) {
2217 tty->print_cr("\n\nDynamic archive name: %s", dynamic_mapinfo->full_path());
2218 tty->print_cr("Dynamic archive version %d", dynamic_mapinfo->version());
2219 SystemDictionaryShared::print_shared_archive(tty, false/*dynamic*/);
2220 }
2221
2222 TrainingData::print_archived_training_data_on(tty);
2223
2224 AOTCodeCache::print_on(tty);
2225
2226 // collect shared symbols and strings
2227 CountSharedSymbols cl;
2228 SymbolTable::shared_symbols_do(&cl);
2229 tty->print_cr("Number of shared symbols: %zu", cl.total());
2230 if (HeapShared::is_loading() && HeapShared::is_loading_mapping_mode()) {
2231 tty->print_cr("Number of shared strings: %zu", StringTable::shared_entry_count());
2232 }
2233 tty->print_cr("VM version: %s\r\n", static_mapinfo->vm_version());
2234 if (FileMapInfo::current_info() == nullptr || _archive_loading_failed) {
2235 tty->print_cr("archive is invalid");
2236 vm_exit(1);
2237 } else {
2238 tty->print_cr("archive is valid");
2239 vm_exit(0);
2240 }
2241 }
2242 }
2243
2244 // JVM/TI RedefineClasses() support:
2245 bool AOTMetaspace::remap_shared_readonly_as_readwrite() {
2246 assert(SafepointSynchronize::is_at_safepoint(), "must be at safepoint");
2247
2248 if (CDSConfig::is_using_archive()) {
2249 // remap the shared readonly space to shared readwrite, private
2250 FileMapInfo* mapinfo = FileMapInfo::current_info();
2251 if (!mapinfo->remap_shared_readonly_as_readwrite()) {
2252 return false;
2253 }
2254 if (FileMapInfo::dynamic_info() != nullptr) {
2255 mapinfo = FileMapInfo::dynamic_info();
2256 if (!mapinfo->remap_shared_readonly_as_readwrite()) {
2257 return false;
2258 }
2259 }
2260 _remapped_readwrite = true;
2261 }
2262 return true;
2263 }
2264
2265 void AOTMetaspace::print_on(outputStream* st) {
2266 if (CDSConfig::is_using_archive()) {
2267 st->print("CDS archive(s) mapped at: ");
2268 address base = (address)MetaspaceObj::aot_metaspace_base();
2269 address static_top = (address)_aot_metaspace_static_top;
2270 address top = (address)MetaspaceObj::aot_metaspace_top();
2271 st->print("[" PTR_FORMAT "-" PTR_FORMAT "-" PTR_FORMAT "), ", p2i(base), p2i(static_top), p2i(top));
2272 st->print("size %zu, ", top - base);
2273 st->print("SharedBaseAddress: " PTR_FORMAT ", ArchiveRelocationMode: %d.", SharedBaseAddress, ArchiveRelocationMode);
2274 } else {
2275 st->print("CDS archive(s) not mapped");
2276 }
2277 st->cr();
2278 }