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