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