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::adjust_heap_sizes_for_dumping() {
1003 if (!CDSConfig::is_dumping_heap() || UseCompressedOops) {
1004 return;
1005 }
1006 // CDS heap dumping requires all string oops to have an offset
1007 // from the heap bottom that can be encoded in 32-bit.
1008 julong max_heap_size = (julong)(4 * G);
1009
1010 if (MinHeapSize > max_heap_size) {
1011 log_debug(aot)("Setting MinHeapSize to 4G for CDS dumping, original size = %zuM", MinHeapSize/M);
1012 FLAG_SET_ERGO(MinHeapSize, max_heap_size);
1013 }
1014 if (InitialHeapSize > max_heap_size) {
1015 log_debug(aot)("Setting InitialHeapSize to 4G for CDS dumping, original size = %zuM", InitialHeapSize/M);
1016 FLAG_SET_ERGO(InitialHeapSize, max_heap_size);
1017 }
1018 if (MaxHeapSize > max_heap_size) {
1019 log_debug(aot)("Setting MaxHeapSize to 4G for CDS dumping, original size = %zuM", MaxHeapSize/M);
1020 FLAG_SET_ERGO(MaxHeapSize, max_heap_size);
1021 }
1022 }
1023 #endif // INCLUDE_CDS_JAVA_HEAP && _LP64
1024
1025 void AOTMetaspace::get_default_classlist(char* default_classlist, const size_t buf_size) {
1026 const char* filesep = os::file_separator();
1027 jio_snprintf(default_classlist, buf_size, "%s%slib%sclasslist",
1028 Arguments::get_java_home(), filesep, filesep);
1029 }
1030
1031 void AOTMetaspace::load_classes(TRAPS) {
1032 char default_classlist[JVM_MAXPATHLEN];
1033 const char* classlist_path;
1034
1035 get_default_classlist(default_classlist, JVM_MAXPATHLEN);
1036 if (SharedClassListFile == nullptr) {
1037 classlist_path = default_classlist;
1038 } else {
1039 classlist_path = SharedClassListFile;
1040 }
1041
1042 aot_log_info(aot)("Loading classes to share ...");
1043 ClassListParser::parse_classlist(classlist_path,
1044 ClassListParser::_parse_all, CHECK);
1045 if (ExtraSharedClassListFile) {
1046 ClassListParser::parse_classlist(ExtraSharedClassListFile,
1047 ClassListParser::_parse_all, CHECK);
1048 }
1049 if (classlist_path != default_classlist) {
1050 struct stat statbuf;
1051 if (os::stat(default_classlist, &statbuf) == 0) {
1052 // File exists, let's use it.
1053 ClassListParser::parse_classlist(default_classlist,
1054 ClassListParser::_parse_lambda_forms_invokers_only, CHECK);
1055 }
1056 }
1057
1058 // Some classes are used at CDS runtime but are not yet loaded at this point.
1059 // We can perform dummmy calls to these classes at dumptime to ensure they
1060 // are archived.
1061 exercise_runtime_cds_code(CHECK);
1062
1063 aot_log_info(aot)("Loading classes to share: done.");
1064 }
1065
1066 void AOTMetaspace::exercise_runtime_cds_code(TRAPS) {
1067 // Exercise the manifest processing code
1068 const char* dummy = "Manifest-Version: 1.0\n";
1069 CDSProtectionDomain::create_jar_manifest(dummy, strlen(dummy), CHECK);
1070
1071 // Exercise FileSystem and URL code
1072 CDSProtectionDomain::to_file_URL("dummy.jar", Handle(), CHECK);
1073 }
1074
1075 bool AOTMetaspace::preimage_static_archive_dumped() {
1076 assert(CDSConfig::is_dumping_preimage_static_archive(), "Required");
1077 return AtomicAccess::load_acquire(&_preimage_static_archive_dumped) == 1;
1078 }
1079
1080 void AOTMetaspace::dump_static_archive_impl(StaticArchiveBuilder& builder, TRAPS) {
1081 if (CDSConfig::is_dumping_preimage_static_archive()) {
1082 // When dumping to the AOT configuration file ensure this function is only executed once.
1083 // Multiple invocations may happen via JCmd, during VM exit or other means (in the future)
1084 // from different threads and possibly concurrently.
1085 if (AtomicAccess::cmpxchg(&_preimage_static_archive_dumped, 0, 1) != 0) {
1086 return;
1087 }
1088 }
1089
1090 if (CDSConfig::is_dumping_classic_static_archive()) {
1091 // We are running with -Xshare:dump
1092 load_classes(CHECK);
1093
1094 if (SharedArchiveConfigFile) {
1095 log_info(aot)("Reading extra data from %s ...", SharedArchiveConfigFile);
1096 read_extra_data(THREAD, SharedArchiveConfigFile);
1097 log_info(aot)("Reading extra data: done.");
1098 }
1099 }
1100
1101 if (CDSConfig::is_dumping_preimage_static_archive()) {
1102 log_info(aot)("Reading lambda form invokers from JDK default classlist ...");
1103 char default_classlist[JVM_MAXPATHLEN];
1104 get_default_classlist(default_classlist, JVM_MAXPATHLEN);
1105 struct stat statbuf;
1106 if (os::stat(default_classlist, &statbuf) == 0) {
1107 ClassListParser::parse_classlist(default_classlist,
1108 ClassListParser::_parse_lambda_forms_invokers_only, CHECK);
1109 }
1110 }
1111
1112 #if INCLUDE_CDS_JAVA_HEAP
1113 if (CDSConfig::is_dumping_heap()) {
1114 if (!CDSConfig::is_dumping_preimage_static_archive()) {
1115 // A single thread is required for Reference handling and deterministic CDS archive.
1116 // Its's not required for dumping preimage, where References won't be archived and
1117 // determinism is not needed.
1118 assert(CDSConfig::allow_only_single_java_thread(), "Required");
1119 }
1120 if (!HeapShared::is_archived_boot_layer_available(THREAD)) {
1121 report_loading_error("archivedBootLayer not available, disabling full module graph");
1122 CDSConfig::stop_dumping_full_module_graph();
1123 }
1124 // Do this before link_shared_classes(), as the following line may load new classes.
1125 HeapShared::init_for_dumping(CHECK);
1126 }
1127 #endif
1128
1129 if (CDSConfig::is_dumping_final_static_archive()) {
1130 if (ExtraSharedClassListFile) {
1131 log_info(aot)("Loading extra classes from %s ...", ExtraSharedClassListFile);
1132 ClassListParser::parse_classlist(ExtraSharedClassListFile,
1133 ClassListParser::_parse_all, CHECK);
1134 }
1135 }
1136
1137 // Rewrite and link classes
1138 log_info(aot)("Rewriting and linking classes ...");
1139
1140 // Link any classes which got missed. This would happen if we have loaded classes that
1141 // were not explicitly specified in the classlist. E.g., if an interface implemented by class K
1142 // fails verification, all other interfaces that were not specified in the classlist but
1143 // are implemented by K are not verified.
1144 link_shared_classes(CHECK);
1145 log_info(aot)("Rewriting and linking classes: done");
1146 TrainingData::init_dumptime_table(CHECK); // captures TrainingDataSetLocker
1147
1148 if (CDSConfig::is_dumping_regenerated_lambdaform_invokers()) {
1149 LambdaFormInvokers::regenerate_holder_classes(CHECK);
1150 }
1151
1152 #if INCLUDE_CDS_JAVA_HEAP
1153 if (CDSConfig::is_dumping_heap()) {
1154 HeapShared::init_heap_writer();
1155 if (CDSConfig::is_dumping_full_module_graph()) {
1156 ClassLoaderDataShared::ensure_module_entry_tables_exist();
1157 ClassLoaderDataShared::build_tables(CHECK);
1158 HeapShared::prepare_for_archiving(CHECK);
1159 }
1160
1161 AOTReferenceObjSupport::initialize(CHECK);
1162 AOTReferenceObjSupport::stabilize_cached_reference_objects(CHECK);
1163
1164 if (CDSConfig::is_dumping_aot_linked_classes()) {
1165 // java.lang.Class::reflectionFactory cannot be archived yet. We set this field
1166 // to null, and it will be initialized again at runtime.
1167 log_debug(aot)("Resetting Class::reflectionFactory");
1168 TempNewSymbol method_name = SymbolTable::new_symbol("resetArchivedStates");
1169 Symbol* method_sig = vmSymbols::void_method_signature();
1170 JavaValue result(T_VOID);
1171 JavaCalls::call_static(&result, vmClasses::Class_klass(),
1172 method_name, method_sig, CHECK);
1173
1174 // Perhaps there is a way to avoid hard-coding these names here.
1175 // See discussion in JDK-8342481.
1176 }
1177 } else {
1178 log_info(aot)("Not dumping heap, reset CDSConfig::_is_using_optimized_module_handling");
1179 CDSConfig::stop_using_optimized_module_handling();
1180 }
1181 #endif
1182
1183 if (!CDSConfig::is_dumping_preimage_static_archive()) {
1184 if (CDSConfig::is_dumping_final_static_archive()) {
1185 FileMapInfo::free_current_info(); // FIXME: should not free current info
1186 }
1187 open_output_mapinfo();
1188 }
1189
1190 VM_PopulateDumpSharedSpace op(builder, _output_mapinfo);
1191 VMThread::execute(&op);
1192
1193 if (AOTCodeCache::is_on_for_dump() && CDSConfig::is_dumping_final_static_archive()) {
1194 CDSConfig::enable_dumping_aot_code();
1195 {
1196 builder.start_ac_region();
1197 // Write the contents to AOT code region before packing the region
1198 AOTCodeCache::dump();
1199 builder.end_ac_region();
1200 }
1201 CDSConfig::disable_dumping_aot_code();
1202 }
1203
1204 bool status = write_static_archive(&builder, _output_mapinfo, op.mapped_heap_info(), op.streamed_heap_info());
1205 assert(!_output_mapinfo->is_open(), "Must be closed already");
1206 _output_mapinfo = nullptr;
1207 if (status && CDSConfig::is_dumping_preimage_static_archive()) {
1208 tty->print_cr("%s AOTConfiguration recorded: %s",
1209 CDSConfig::has_temp_aot_config_file() ? "Temporary" : "", AOTConfiguration);
1210 if (CDSConfig::is_single_command_training()) {
1211 fork_and_dump_final_static_archive(CHECK);
1212 }
1213 }
1214
1215 if (!status) {
1216 THROW_MSG(vmSymbols::java_io_IOException(), "Encountered error while dumping");
1217 }
1218 }
1219
1220 bool AOTMetaspace::write_static_archive(ArchiveBuilder* builder,
1221 FileMapInfo* map_info,
1222 AOTMappedHeapInfo* mapped_heap_info,
1223 AOTStreamedHeapInfo* streamed_heap_info) {
1224 // relocate the data so that it can be mapped to AOTMetaspace::requested_base_address()
1225 // without runtime relocation.
1226 builder->relocate_to_requested();
1227 if (!map_info->is_open()) {
1228 return false;
1229 }
1230 map_info->prepare_for_writing();
1231 builder->write_archive(map_info, mapped_heap_info, streamed_heap_info);
1232 return true;
1233 }
1234
1235 static void print_java_launcher(outputStream* st) {
1236 st->print("%s%sbin%sjava", Arguments::get_java_home(), os::file_separator(), os::file_separator());
1237 }
1238
1239 static void append_args(GrowableArray<Handle>* args, const char* arg, TRAPS) {
1240 Handle string = java_lang_String::create_from_str(arg, CHECK);
1241 args->append(string);
1242 }
1243
1244 // Pass all options in Arguments::jvm_args_array() to a child JVM process
1245 // using the JAVA_TOOL_OPTIONS environment variable.
1246 static int exec_jvm_with_java_tool_options(const char* java_launcher_path, TRAPS) {
1247 ResourceMark rm(THREAD);
1248 HandleMark hm(THREAD);
1249 GrowableArray<Handle> args;
1250
1251 const char* cp = Arguments::get_appclasspath();
1252 if (cp != nullptr && strlen(cp) > 0 && strcmp(cp, ".") != 0) {
1253 // We cannot use "-cp", because "-cp" is only interpreted by the java launcher,
1254 // and is not interpreter by arguments.cpp when it loads args from JAVA_TOOL_OPTIONS
1255 stringStream ss;
1256 ss.print("-Djava.class.path=");
1257 ss.print_raw(cp);
1258 append_args(&args, ss.freeze(), CHECK_0);
1259 // CDS$ProcessLauncher::execWithJavaToolOptions() must unset CLASSPATH, which has
1260 // a higher priority than -Djava.class.path=
1261 }
1262
1263 // Pass all arguments. These include those from JAVA_TOOL_OPTIONS and _JAVA_OPTIONS.
1264 for (int i = 0; i < Arguments::num_jvm_args(); i++) {
1265 const char* arg = Arguments::jvm_args_array()[i];
1266 if (strstr(arg, "-XX:AOTCacheOutput=") == arg || // arg starts with ...
1267 strstr(arg, "-XX:AOTConfiguration=") == arg ||
1268 strstr(arg, "-XX:AOTMode=") == arg) {
1269 // Filter these out. They wiill be set below.
1270 } else {
1271 append_args(&args, arg, CHECK_0);
1272 }
1273 }
1274
1275 // Note: because we are running in AOTMode=record, JDK_AOT_VM_OPTIONS have not been
1276 // parsed, so they are not in Arguments::jvm_args_array. If JDK_AOT_VM_OPTIONS is in
1277 // the environment, it will be inherited and parsed by the child JVM process
1278 // in Arguments::parse_java_tool_options_environment_variable().
1279 precond(strcmp(AOTMode, "record") == 0);
1280
1281 // We don't pass Arguments::jvm_flags_array(), as those will be added by
1282 // the child process when it loads .hotspotrc
1283
1284 {
1285 // If AOTCacheOutput contains %p, it should have been already substituted with the
1286 // pid of the training process.
1287 stringStream ss;
1288 ss.print("-XX:AOTCacheOutput=");
1289 ss.print_raw(AOTCacheOutput);
1290 append_args(&args, ss.freeze(), CHECK_0);
1291 }
1292 {
1293 // If AOTCacheConfiguration contains %p, it should have been already substituted with the
1294 // pid of the training process.
1295 // If AOTCacheConfiguration was not explicitly specified, it should have been assigned a
1296 // temporary file name.
1297 stringStream ss;
1298 ss.print("-XX:AOTConfiguration=");
1299 ss.print_raw(AOTConfiguration);
1300 append_args(&args, ss.freeze(), CHECK_0);
1301 }
1302
1303 append_args(&args, "-XX:AOTMode=create", CHECK_0);
1304
1305 Symbol* klass_name = SymbolTable::new_symbol("jdk/internal/misc/CDS$ProcessLauncher");
1306 Klass* k = SystemDictionary::resolve_or_fail(klass_name, true, CHECK_0);
1307 Symbol* methodName = SymbolTable::new_symbol("execWithJavaToolOptions");
1308 Symbol* methodSignature = SymbolTable::new_symbol("(Ljava/lang/String;[Ljava/lang/String;)I");
1309
1310 Handle launcher = java_lang_String::create_from_str(java_launcher_path, CHECK_0);
1311 objArrayOop array = oopFactory::new_objArray(vmClasses::String_klass(), args.length(), CHECK_0);
1312 for (int i = 0; i < args.length(); i++) {
1313 array->obj_at_put(i, args.at(i)());
1314 }
1315 objArrayHandle launcher_args(THREAD, array);
1316
1317 // The following call will pass all options inside the JAVA_TOOL_OPTIONS env variable to
1318 // the child process. It will also clear the _JAVA_OPTIONS and CLASSPATH env variables for
1319 // the child process.
1320 //
1321 // Note: the env variables are set only for the child process. They are not changed
1322 // for the current process. See java.lang.ProcessBuilder::environment().
1323 JavaValue result(T_OBJECT);
1324 JavaCallArguments javacall_args(2);
1325 javacall_args.push_oop(launcher);
1326 javacall_args.push_oop(launcher_args);
1327 JavaCalls::call_static(&result,
1328 InstanceKlass::cast(k),
1329 methodName,
1330 methodSignature,
1331 &javacall_args,
1332 CHECK_0);
1333 return result.get_jint();
1334 }
1335
1336 void AOTMetaspace::fork_and_dump_final_static_archive(TRAPS) {
1337 assert(CDSConfig::is_dumping_preimage_static_archive(), "sanity");
1338
1339 ResourceMark rm;
1340 stringStream ss;
1341 print_java_launcher(&ss);
1342 const char* cmd = ss.freeze();
1343 tty->print_cr("Launching child process %s to assemble AOT cache %s using configuration %s", cmd, AOTCacheOutput, AOTConfiguration);
1344 int status = exec_jvm_with_java_tool_options(cmd, CHECK);
1345 if (status != 0) {
1346 log_error(aot)("Child process failed; status = %d", status);
1347 // We leave the temp config file for debugging
1348 } else if (CDSConfig::has_temp_aot_config_file()) {
1349 const char* tmp_config = AOTConfiguration;
1350 // On Windows, need WRITE permission to remove the file.
1351 WINDOWS_ONLY(chmod(tmp_config, _S_IREAD | _S_IWRITE));
1352 status = remove(tmp_config);
1353 if (status != 0) {
1354 log_error(aot)("Failed to remove temporary AOT configuration file %s", tmp_config);
1355 } else {
1356 tty->print_cr("Removed temporary AOT configuration file %s", tmp_config);
1357 }
1358 }
1359 }
1360
1361 // Returns true if the class's status has changed.
1362 bool AOTMetaspace::try_link_class(JavaThread* current, InstanceKlass* ik) {
1363 ExceptionMark em(current);
1364 JavaThread* THREAD = current; // For exception macros.
1365 assert(CDSConfig::is_dumping_archive(), "sanity");
1366
1367 if (ik->in_aot_cache() && !CDSConfig::is_dumping_final_static_archive()) {
1368 assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
1369 return false;
1370 }
1371
1372 if (ik->is_loaded() && !ik->is_linked() && ik->can_be_verified_at_dumptime() &&
1373 !SystemDictionaryShared::has_class_failed_verification(ik)) {
1374 bool saved = BytecodeVerificationLocal;
1375 if (ik->defined_by_other_loaders() && ik->class_loader() == nullptr) {
1376 // The verification decision is based on BytecodeVerificationRemote
1377 // for non-system classes. Since we are using the null classloader
1378 // to load non-system classes for customized class loaders during dumping,
1379 // we need to temporarily change BytecodeVerificationLocal to be the same as
1380 // BytecodeVerificationRemote. Note this can cause the parent system
1381 // classes also being verified. The extra overhead is acceptable during
1382 // dumping.
1383 BytecodeVerificationLocal = BytecodeVerificationRemote;
1384 }
1385 ik->link_class(THREAD);
1386 if (HAS_PENDING_EXCEPTION) {
1387 ResourceMark rm(THREAD);
1388 oop message = java_lang_Throwable::message(current->pending_exception());
1389 aot_log_warning(aot)("Preload Warning: Verification failed for %s because a %s was thrown: %s",
1390 ik->external_name(),
1391 current->pending_exception()->klass()->external_name(),
1392 message == nullptr ? "(no message)" : java_lang_String::as_utf8_string(message));
1393 CLEAR_PENDING_EXCEPTION;
1394 SystemDictionaryShared::set_class_has_failed_verification(ik);
1395 } else {
1396 assert(!SystemDictionaryShared::has_class_failed_verification(ik), "sanity");
1397 ik->compute_has_loops_flag_for_methods();
1398 }
1399 BytecodeVerificationLocal = saved;
1400 return true;
1401 } else {
1402 return false;
1403 }
1404 }
1405
1406 void VM_PopulateDumpSharedSpace::dump_java_heap_objects() {
1407 if (CDSConfig::is_dumping_heap()) {
1408 HeapShared::write_heap(&_mapped_heap_info, &_streamed_heap_info);
1409 } else {
1410 CDSConfig::log_reasons_for_not_dumping_heap();
1411 }
1412 }
1413
1414 void AOTMetaspace::set_aot_metaspace_range(void* base, void *static_top, void* top) {
1415 assert(base <= static_top && static_top <= top, "must be");
1416 _aot_metaspace_static_top = static_top;
1417 MetaspaceObj::set_aot_metaspace_range(base, top);
1418 }
1419
1420 bool AOTMetaspace::in_aot_cache_dynamic_region(void* p) {
1421 if ((p < MetaspaceObj::aot_metaspace_top()) &&
1422 (p >= _aot_metaspace_static_top)) {
1423 return true;
1424 } else {
1425 return false;
1426 }
1427 }
1428
1429 bool AOTMetaspace::in_aot_cache_static_region(void* p) {
1430 if (in_aot_cache(p) && !in_aot_cache_dynamic_region(p)) {
1431 return true;
1432 } else {
1433 return false;
1434 }
1435 }
1436
1437 // This function is called when the JVM is unable to load the specified archive(s) due to one
1438 // of the following conditions.
1439 // - There's an error that indicates that the archive(s) files were corrupt or otherwise damaged.
1440 // - When -XX:+RequireSharedSpaces is specified, AND the JVM cannot load the archive(s) due
1441 // to version or classpath mismatch.
1442 void AOTMetaspace::unrecoverable_loading_error(const char* message) {
1443 report_loading_error("%s", message);
1444
1445 if (CDSConfig::is_dumping_final_static_archive()) {
1446 vm_exit_during_initialization("Must be a valid AOT configuration generated by the current JVM", AOTConfiguration);
1447 } else if (CDSConfig::new_aot_flags_used()) {
1448 vm_exit_during_initialization("Unable to use AOT cache.", nullptr);
1449 } else {
1450 vm_exit_during_initialization("Unable to use shared archive. Unrecoverable archive loading error (run with -Xlog:aot,cds for details)", message);
1451 }
1452 }
1453
1454 void AOTMetaspace::report_loading_error(const char* format, ...) {
1455 // When using AOT cache, errors messages are always printed on the error channel.
1456 LogStream ls_aot(LogLevel::Error, LogTagSetMapping<LOG_TAGS(aot)>::tagset());
1457
1458 // If we are loading load the default CDS archive, it may fail due to incompatible VM options.
1459 // Print at the info level to avoid excessive verbosity.
1460 // However, if the user has specified a CDS archive (or AOT cache), they would be interested in
1461 // knowing that the loading fails, so we print at the error level.
1462 LogLevelType level = (!CDSConfig::is_using_archive() || CDSConfig::is_using_only_default_archive()) ?
1463 LogLevel::Info : LogLevel::Error;
1464 LogStream ls_cds(level, LogTagSetMapping<LOG_TAGS(cds)>::tagset());
1465
1466 LogStream& ls = CDSConfig::new_aot_flags_used() ? ls_aot : ls_cds;
1467 if (!ls.is_enabled()) {
1468 return;
1469 }
1470
1471 va_list ap;
1472 va_start(ap, format);
1473
1474 static bool printed_error = false;
1475 if (!printed_error) { // No need for locks. Loading error checks happen only in main thread.
1476 ls.print_cr("An error has occurred while processing the %s. Run with -Xlog:%s for details.",
1477 CDSConfig::type_of_archive_being_loaded(), CDSConfig::new_aot_flags_used() ? "aot" : "aot,cds");
1478 printed_error = true;
1479 }
1480 ls.vprint_cr(format, ap);
1481
1482 va_end(ap);
1483 }
1484
1485 // This function is called when the JVM is unable to write the specified CDS archive due to an
1486 // unrecoverable error.
1487 void AOTMetaspace::unrecoverable_writing_error(const char* message) {
1488 writing_error(message);
1489 vm_direct_exit(1);
1490 }
1491
1492 // This function is called when the JVM is unable to write the specified CDS archive due to a
1493 // an error. The error will be propagated
1494 void AOTMetaspace::writing_error(const char* message) {
1495 aot_log_error(aot)("An error has occurred while writing the shared archive file.");
1496 if (message != nullptr) {
1497 aot_log_error(aot)("%s", message);
1498 }
1499 }
1500
1501 void AOTMetaspace::initialize_runtime_shared_and_meta_spaces() {
1502 assert(CDSConfig::is_using_archive(), "Must be called when UseSharedSpaces is enabled");
1503 MapArchiveResult result = MAP_ARCHIVE_OTHER_FAILURE;
1504
1505 FileMapInfo* static_mapinfo = open_static_archive();
1506 FileMapInfo* dynamic_mapinfo = nullptr;
1507
1508 if (static_mapinfo != nullptr) {
1509 aot_log_info(aot)("Core region alignment: %zu", static_mapinfo->core_region_alignment());
1510 dynamic_mapinfo = open_dynamic_archive();
1511
1512 aot_log_info(aot)("ArchiveRelocationMode: %d", ArchiveRelocationMode);
1513
1514 // First try to map at the requested address
1515 result = map_archives(static_mapinfo, dynamic_mapinfo, true);
1516 if (result == MAP_ARCHIVE_MMAP_FAILURE) {
1517 // Mapping has failed (probably due to ASLR). Let's map at an address chosen
1518 // by the OS.
1519 aot_log_info(aot)("Try to map archive(s) at an alternative address");
1520 result = map_archives(static_mapinfo, dynamic_mapinfo, false);
1521 }
1522 }
1523
1524 if (result == MAP_ARCHIVE_SUCCESS) {
1525 bool dynamic_mapped = (dynamic_mapinfo != nullptr && dynamic_mapinfo->is_mapped());
1526 char* cds_base = static_mapinfo->mapped_base();
1527 char* cds_end = dynamic_mapped ? dynamic_mapinfo->mapped_end() : static_mapinfo->mapped_end();
1528 // Register CDS memory region with LSan.
1529 LSAN_REGISTER_ROOT_REGION(cds_base, cds_end - cds_base);
1530 set_aot_metaspace_range(cds_base, static_mapinfo->mapped_end(), cds_end);
1531 _relocation_delta = static_mapinfo->relocation_delta();
1532 _requested_base_address = static_mapinfo->requested_base_address();
1533 if (dynamic_mapped) {
1534 // turn AutoCreateSharedArchive off if successfully mapped
1535 AutoCreateSharedArchive = false;
1536 }
1537 } else {
1538 set_aot_metaspace_range(nullptr, nullptr, nullptr);
1539 if (CDSConfig::is_dumping_dynamic_archive()) {
1540 aot_log_warning(aot)("-XX:ArchiveClassesAtExit is unsupported when base CDS archive is not loaded. Run with -Xlog:cds for more info.");
1541 }
1542 UseSharedSpaces = false;
1543 // The base archive cannot be mapped. We cannot dump the dynamic shared archive.
1544 AutoCreateSharedArchive = false;
1545 CDSConfig::disable_dumping_dynamic_archive();
1546 if (PrintSharedArchiveAndExit) {
1547 AOTMetaspace::unrecoverable_loading_error("Unable to use shared archive.");
1548 } else {
1549 if (RequireSharedSpaces) {
1550 AOTMetaspace::unrecoverable_loading_error("Unable to map shared spaces");
1551 } else {
1552 report_loading_error("Unable to map shared spaces");
1553 }
1554 }
1555 }
1556
1557 // If mapping failed and -XShare:on, the vm should exit
1558 bool has_failed = false;
1559 if (static_mapinfo != nullptr && !static_mapinfo->is_mapped()) {
1560 has_failed = true;
1561 delete static_mapinfo;
1562 }
1563 if (dynamic_mapinfo != nullptr && !dynamic_mapinfo->is_mapped()) {
1564 has_failed = true;
1565 delete dynamic_mapinfo;
1566 }
1567 if (RequireSharedSpaces && has_failed) {
1568 AOTMetaspace::unrecoverable_loading_error("Unable to map shared spaces");
1569 }
1570 }
1571
1572 FileMapInfo* AOTMetaspace::open_static_archive() {
1573 const char* static_archive = CDSConfig::input_static_archive_path();
1574 assert(static_archive != nullptr, "sanity");
1575 FileMapInfo* mapinfo = new FileMapInfo(static_archive, true);
1576 if (!mapinfo->open_as_input()) {
1577 delete(mapinfo);
1578 log_info(cds)("Opening of static archive %s failed", static_archive);
1579 return nullptr;
1580 }
1581 return mapinfo;
1582 }
1583
1584 FileMapInfo* AOTMetaspace::open_dynamic_archive() {
1585 if (CDSConfig::is_dumping_dynamic_archive()) {
1586 return nullptr;
1587 }
1588 const char* dynamic_archive = CDSConfig::input_dynamic_archive_path();
1589 if (dynamic_archive == nullptr) {
1590 return nullptr;
1591 }
1592
1593 FileMapInfo* mapinfo = new FileMapInfo(dynamic_archive, false);
1594 if (!mapinfo->open_as_input()) {
1595 delete(mapinfo);
1596 if (RequireSharedSpaces) {
1597 AOTMetaspace::unrecoverable_loading_error("Failed to initialize dynamic archive");
1598 }
1599 return nullptr;
1600 }
1601 return mapinfo;
1602 }
1603
1604 // use_requested_addr:
1605 // true = map at FileMapHeader::_requested_base_address
1606 // false = map at an alternative address picked by OS.
1607 MapArchiveResult AOTMetaspace::map_archives(FileMapInfo* static_mapinfo, FileMapInfo* dynamic_mapinfo,
1608 bool use_requested_addr) {
1609 if (use_requested_addr && static_mapinfo->requested_base_address() == nullptr) {
1610 aot_log_info(aot)("Archive(s) were created with -XX:SharedBaseAddress=0. Always map at os-selected address.");
1611 return MAP_ARCHIVE_MMAP_FAILURE;
1612 }
1613
1614 PRODUCT_ONLY(if (ArchiveRelocationMode == 1 && use_requested_addr) {
1615 // For product build only -- this is for benchmarking the cost of doing relocation.
1616 // For debug builds, the check is done below, after reserving the space, for better test coverage
1617 // (see comment below).
1618 aot_log_info(aot)("ArchiveRelocationMode == 1: always map archive(s) at an alternative address");
1619 return MAP_ARCHIVE_MMAP_FAILURE;
1620 });
1621
1622 if (ArchiveRelocationMode == 2 && !use_requested_addr) {
1623 aot_log_info(aot)("ArchiveRelocationMode == 2: never map archive(s) at an alternative address");
1624 return MAP_ARCHIVE_MMAP_FAILURE;
1625 };
1626
1627 if (dynamic_mapinfo != nullptr) {
1628 // Ensure that the OS won't be able to allocate new memory spaces between the two
1629 // archives, or else it would mess up the simple comparison in MetaspaceObj::in_aot_cache().
1630 assert(static_mapinfo->mapping_end_offset() == dynamic_mapinfo->mapping_base_offset(), "no gap");
1631 }
1632
1633 ReservedSpace total_space_rs, archive_space_rs, class_space_rs;
1634 MapArchiveResult result = MAP_ARCHIVE_OTHER_FAILURE;
1635 size_t prot_zone_size = 0;
1636 char* mapped_base_address = reserve_address_space_for_archives(static_mapinfo,
1637 dynamic_mapinfo,
1638 use_requested_addr,
1639 total_space_rs,
1640 archive_space_rs,
1641 class_space_rs);
1642 if (mapped_base_address == nullptr) {
1643 result = MAP_ARCHIVE_MMAP_FAILURE;
1644 aot_log_debug(aot)("Failed to reserve spaces (use_requested_addr=%u)", (unsigned)use_requested_addr);
1645 } else {
1646
1647 CLASS_SPACE_ONLY(prot_zone_size = protection_zone_size();)
1648
1649 // Some sanity checks after reserving address spaces for archives
1650 // and class space.
1651 assert(archive_space_rs.is_reserved(), "Sanity");
1652
1653 #if INCLUDE_CLASS_SPACE
1654 assert(archive_space_rs.base() == mapped_base_address &&
1655 archive_space_rs.size() > protection_zone_size(),
1656 "Archive space must lead and include the protection zone");
1657 // Class space must closely follow the archive space. Both spaces
1658 // must be aligned correctly.
1659 assert(class_space_rs.is_reserved() && class_space_rs.size() > 0,
1660 "A class space should have been reserved");
1661 assert(class_space_rs.base() >= archive_space_rs.end(),
1662 "class space should follow the cds archive space");
1663 assert(is_aligned(archive_space_rs.base(),
1664 core_region_alignment()),
1665 "Archive space misaligned");
1666 assert(is_aligned(class_space_rs.base(),
1667 Metaspace::reserve_alignment()),
1668 "class space misaligned");
1669 #endif // INCLUDE_CLASS_SPACE
1670
1671 aot_log_info(aot)("Reserved archive_space_rs [" INTPTR_FORMAT " - " INTPTR_FORMAT "] (%zu) bytes%s",
1672 p2i(archive_space_rs.base()), p2i(archive_space_rs.end()), archive_space_rs.size(),
1673 (prot_zone_size > 0 ? " (includes protection zone)" : ""));
1674 aot_log_info(aot)("Reserved class_space_rs [" INTPTR_FORMAT " - " INTPTR_FORMAT "] (%zu) bytes",
1675 p2i(class_space_rs.base()), p2i(class_space_rs.end()), class_space_rs.size());
1676
1677 if (AOTMetaspace::use_windows_memory_mapping()) {
1678 // We have now reserved address space for the archives, and will map in
1679 // the archive files into this space.
1680 //
1681 // Special handling for Windows: on Windows we cannot map a file view
1682 // into an existing memory mapping. So, we unmap the address range we
1683 // just reserved again, which will make it available for mapping the
1684 // archives.
1685 // Reserving this range has not been for naught however since it makes
1686 // us reasonably sure the address range is available.
1687 //
1688 // But still it may fail, since between unmapping the range and mapping
1689 // in the archive someone else may grab the address space. Therefore
1690 // there is a fallback in FileMap::map_region() where we just read in
1691 // the archive files sequentially instead of mapping it in. We couple
1692 // this with use_requested_addr, since we're going to patch all the
1693 // pointers anyway so there's no benefit to mmap.
1694 if (use_requested_addr) {
1695 assert(!total_space_rs.is_reserved(), "Should not be reserved for Windows");
1696 aot_log_info(aot)("Windows mmap workaround: releasing archive space.");
1697 MemoryReserver::release(archive_space_rs);
1698 // Mark as not reserved
1699 archive_space_rs = {};
1700 // The protection zone is part of the archive:
1701 // See comment above, the Windows way of loading CDS is to mmap the individual
1702 // parts of the archive into the address region we just vacated. The protection
1703 // zone will not be mapped (and, in fact, does not exist as physical region in
1704 // the archive). Therefore, after removing the archive space above, we must
1705 // re-reserve the protection zone part lest something else gets mapped into that
1706 // area later.
1707 if (prot_zone_size > 0) {
1708 assert(prot_zone_size >= os::vm_allocation_granularity(), "must be"); // not just page size!
1709 char* p = os::attempt_reserve_memory_at(mapped_base_address, prot_zone_size,
1710 mtClassShared);
1711 assert(p == mapped_base_address || p == nullptr, "must be");
1712 if (p == nullptr) {
1713 aot_log_debug(aot)("Failed to re-reserve protection zone");
1714 return MAP_ARCHIVE_MMAP_FAILURE;
1715 }
1716 }
1717 }
1718 }
1719
1720 if (prot_zone_size > 0) {
1721 os::commit_memory(mapped_base_address, prot_zone_size, false); // will later be protected
1722 // Before mapping the core regions into the newly established address space, we mark
1723 // start and the end of the future protection zone with canaries. That way we easily
1724 // catch mapping errors (accidentally mapping data into the future protection zone).
1725 *(mapped_base_address) = 'P';
1726 *(mapped_base_address + prot_zone_size - 1) = 'P';
1727 }
1728
1729 MapArchiveResult static_result = map_archive(static_mapinfo, mapped_base_address, archive_space_rs);
1730 MapArchiveResult dynamic_result = (static_result == MAP_ARCHIVE_SUCCESS) ?
1731 map_archive(dynamic_mapinfo, mapped_base_address, archive_space_rs) : MAP_ARCHIVE_OTHER_FAILURE;
1732
1733 DEBUG_ONLY(if (ArchiveRelocationMode == 1 && use_requested_addr) {
1734 // This is for simulating mmap failures at the requested address. In
1735 // debug builds, we do it here (after all archives have possibly been
1736 // mapped), so we can thoroughly test the code for failure handling
1737 // (releasing all allocated resource, etc).
1738 aot_log_info(aot)("ArchiveRelocationMode == 1: always map archive(s) at an alternative address");
1739 if (static_result == MAP_ARCHIVE_SUCCESS) {
1740 static_result = MAP_ARCHIVE_MMAP_FAILURE;
1741 }
1742 if (dynamic_result == MAP_ARCHIVE_SUCCESS) {
1743 dynamic_result = MAP_ARCHIVE_MMAP_FAILURE;
1744 }
1745 });
1746
1747 if (static_result == MAP_ARCHIVE_SUCCESS) {
1748 if (dynamic_result == MAP_ARCHIVE_SUCCESS) {
1749 result = MAP_ARCHIVE_SUCCESS;
1750 } else if (dynamic_result == MAP_ARCHIVE_OTHER_FAILURE) {
1751 assert(dynamic_mapinfo != nullptr && !dynamic_mapinfo->is_mapped(), "must have failed");
1752 // No need to retry mapping the dynamic archive again, as it will never succeed
1753 // (bad file, etc) -- just keep the base archive.
1754 log_warning(cds, dynamic)("Unable to use shared archive. The top archive failed to load: %s",
1755 dynamic_mapinfo->full_path());
1756 result = MAP_ARCHIVE_SUCCESS;
1757 // TODO, we can give the unused space for the dynamic archive to class_space_rs, but there's no
1758 // easy API to do that right now.
1759 } else {
1760 result = MAP_ARCHIVE_MMAP_FAILURE;
1761 }
1762 } else if (static_result == MAP_ARCHIVE_OTHER_FAILURE) {
1763 result = MAP_ARCHIVE_OTHER_FAILURE;
1764 } else {
1765 result = MAP_ARCHIVE_MMAP_FAILURE;
1766 }
1767 }
1768
1769 if (result == MAP_ARCHIVE_SUCCESS) {
1770 SharedBaseAddress = (size_t)mapped_base_address;
1771 #if INCLUDE_CLASS_SPACE
1772 assert(prot_zone_size > 0 &&
1773 *(mapped_base_address) == 'P' &&
1774 *(mapped_base_address + prot_zone_size - 1) == 'P',
1775 "Protection zone was overwritten?");
1776 // Set up ccs in metaspace.
1777 Metaspace::initialize_class_space(class_space_rs);
1778
1779 // Set up compressed Klass pointer encoding: the encoding range must
1780 // cover both archive and class space.
1781 const address klass_range_start = (address)mapped_base_address;
1782 const size_t klass_range_size = (address)class_space_rs.end() - klass_range_start;
1783 if (INCLUDE_CDS_JAVA_HEAP || UseCompactObjectHeaders) {
1784 // The CDS archive may contain narrow Klass IDs that were precomputed at archive generation time:
1785 // - every archived java object header (only if INCLUDE_CDS_JAVA_HEAP)
1786 // - every archived Klass' prototype (only if +UseCompactObjectHeaders)
1787 //
1788 // In order for those IDs to still be valid, we need to dictate base and shift: base should be the
1789 // mapping start (including protection zone), shift should be the shift used at archive generation time.
1790 CompressedKlassPointers::initialize_for_given_encoding(
1791 klass_range_start, klass_range_size,
1792 klass_range_start, ArchiveBuilder::precomputed_narrow_klass_shift() // precomputed encoding, see ArchiveBuilder
1793 );
1794 assert(CompressedKlassPointers::base() == klass_range_start, "must be");
1795 } else {
1796 // Let JVM freely choose encoding base and shift
1797 CompressedKlassPointers::initialize(klass_range_start, klass_range_size);
1798 assert(CompressedKlassPointers::base() == nullptr ||
1799 CompressedKlassPointers::base() == klass_range_start, "must be");
1800 }
1801 // Establish protection zone, but only if we need one
1802 if (CompressedKlassPointers::base() == klass_range_start) {
1803 CompressedKlassPointers::establish_protection_zone(klass_range_start, prot_zone_size);
1804 }
1805
1806 if (static_mapinfo->can_use_heap_region()) {
1807 if (static_mapinfo->object_streaming_mode()) {
1808 HeapShared::initialize_loading_mode(HeapArchiveMode::_streaming);
1809 } else {
1810 // map_or_load_heap_region() compares the current narrow oop and klass encodings
1811 // with the archived ones, so it must be done after all encodings are determined.
1812 static_mapinfo->map_or_load_heap_region();
1813 HeapShared::initialize_loading_mode(HeapArchiveMode::_mapping);
1814 }
1815 } else {
1816 FileMapRegion* r = static_mapinfo->region_at(AOTMetaspace::hp);
1817 if (r->used() > 0) {
1818 AOTMetaspace::report_loading_error("Cannot use CDS heap data.");
1819 }
1820 if (!CDSConfig::is_dumping_static_archive()) {
1821 CDSConfig::stop_using_full_module_graph("No CDS heap data");
1822 }
1823 }
1824 #endif // INCLUDE_CLASS_SPACE
1825 log_info(aot)("initial optimized module handling: %s", CDSConfig::is_using_optimized_module_handling() ? "enabled" : "disabled");
1826 log_info(aot)("initial full module graph: %s", CDSConfig::is_using_full_module_graph() ? "enabled" : "disabled");
1827 } else {
1828 unmap_archive(static_mapinfo);
1829 unmap_archive(dynamic_mapinfo);
1830 release_reserved_spaces(total_space_rs, archive_space_rs, class_space_rs);
1831 }
1832
1833 return result;
1834 }
1835
1836
1837 // This will reserve two address spaces suitable to house Klass structures, one
1838 // for the cds archives (static archive and optionally dynamic archive) and
1839 // optionally one move for ccs.
1840 //
1841 // Since both spaces must fall within the compressed class pointer encoding
1842 // range, they are allocated close to each other.
1843 //
1844 // Space for archives will be reserved first, followed by a potential gap,
1845 // followed by the space for ccs:
1846 //
1847 // +-- Base address A B End
1848 // | | | |
1849 // v v v v
1850 // +-------------+--------------+ +----------------------+
1851 // | static arc | [dyn. arch] | [gap] | compr. class space |
1852 // +-------------+--------------+ +----------------------+
1853 //
1854 // (The gap may result from different alignment requirements between metaspace
1855 // and CDS)
1856 //
1857 // The range encompassing both spaces will be suitable to en/decode narrow Klass
1858 // pointers: the base will be valid for encoding the range [Base, End) and not
1859 // surpass the max. range for that encoding.
1860 //
1861 // On 32-bit, a "narrow" Klass is just the pointer itself, and the Klass encoding
1862 // range encompasses the whole address range. Consequently, we can "decode" and
1863 // "encode" any pointer anywhere, and so are free to place the CDS archive anywhere:
1864 //
1865 // +-- Base address End
1866 // | |
1867 // v v
1868 // +-------------+--------------+
1869 // | static arc | [dyn. arch] |
1870 // +-------------+--------------+
1871 //
1872 // Base address: If use_archive_base_addr address is true, the Base address is
1873 // determined by the address stored in the static archive. If
1874 // use_archive_base_addr address is false, this base address is determined
1875 // by the platform.
1876 //
1877 // Return:
1878 //
1879 // - On success:
1880 // - total_space_rs will be reserved as whole for archive_space_rs and
1881 // class_space_rs on 64-bit.
1882 // On Windows, try reserve archive_space_rs and class_space_rs
1883 // separately first if use_archive_base_addr is true.
1884 // - archive_space_rs will be reserved and large enough to host static and
1885 // if needed dynamic archive: [Base, A).
1886 // archive_space_rs.base and size will be aligned to CDS reserve
1887 // granularity.
1888 // - class_space_rs: On 64-bit, class_space_rs will be reserved. Its start
1889 // address will be aligned to metaspace reserve alignment, which may differ
1890 // from CDS alignment. It will follow the cds archive space, close enough
1891 // such that narrow class pointer encoding covers both spaces.
1892 // - On error: null is returned and the spaces remain unreserved.
1893 char* AOTMetaspace::reserve_address_space_for_archives(FileMapInfo* static_mapinfo,
1894 FileMapInfo* dynamic_mapinfo,
1895 bool use_archive_base_addr,
1896 ReservedSpace& total_space_rs,
1897 ReservedSpace& archive_space_rs,
1898 ReservedSpace& class_space_rs) {
1899
1900 address const base_address = (address) (use_archive_base_addr ? static_mapinfo->requested_base_address() : nullptr);
1901 const size_t archive_space_alignment = core_region_alignment();
1902
1903 // Size and requested location of the archive_space_rs (for both static and dynamic archives)
1904 size_t archive_end_offset = (dynamic_mapinfo == nullptr) ? static_mapinfo->mapping_end_offset() : dynamic_mapinfo->mapping_end_offset();
1905 size_t archive_space_size = align_up(archive_end_offset, archive_space_alignment);
1906
1907 #if !INCLUDE_CLASS_SPACE
1908
1909 // Get the simple case out of the way first:
1910 // no compressed class space, simple allocation.
1911
1912 // When running without class space, requested archive base should be aligned to cds core alignment.
1913 assert(is_aligned(base_address, archive_space_alignment),
1914 "Archive base address unaligned: " PTR_FORMAT ", needs alignment: %zu.",
1915 p2i(base_address), archive_space_alignment);
1916
1917 archive_space_rs = MemoryReserver::reserve((char*)base_address,
1918 archive_space_size,
1919 archive_space_alignment,
1920 os::vm_page_size(),
1921 mtNone);
1922 if (archive_space_rs.is_reserved()) {
1923 assert(base_address == nullptr ||
1924 (address)archive_space_rs.base() == base_address, "Sanity");
1925 // Register archive space with NMT.
1926 MemTracker::record_virtual_memory_tag(archive_space_rs, mtClassShared);
1927 return archive_space_rs.base();
1928 }
1929
1930 return nullptr;
1931
1932 #else
1933
1934 // INCLUDE_CLASS_SPACE=1
1935 // Complex case: two spaces adjacent to each other, both to be addressable
1936 // with narrow class pointers.
1937 // We reserve the whole range spanning both spaces, then split that range up.
1938
1939 const size_t class_space_alignment = Metaspace::reserve_alignment();
1940
1941 // When running with class space, requested archive base must satisfy both cds core alignment
1942 // and class space alignment.
1943 const size_t base_address_alignment = MAX2(class_space_alignment, archive_space_alignment);
1944 assert(is_aligned(base_address, base_address_alignment),
1945 "Archive base address unaligned: " PTR_FORMAT ", needs alignment: %zu.",
1946 p2i(base_address), base_address_alignment);
1947
1948 size_t class_space_size = CompressedClassSpaceSize;
1949 assert(CompressedClassSpaceSize > 0 &&
1950 is_aligned(CompressedClassSpaceSize, class_space_alignment),
1951 "CompressedClassSpaceSize malformed: %zu", CompressedClassSpaceSize);
1952
1953 const size_t ccs_begin_offset = align_up(archive_space_size, class_space_alignment);
1954 const size_t gap_size = ccs_begin_offset - archive_space_size;
1955
1956 // Reduce class space size if it would not fit into the Klass encoding range
1957 constexpr size_t max_encoding_range_size = 4 * G;
1958 guarantee(archive_space_size < max_encoding_range_size - class_space_alignment, "Archive too large");
1959 if ((archive_space_size + gap_size + class_space_size) > max_encoding_range_size) {
1960 class_space_size = align_down(max_encoding_range_size - archive_space_size - gap_size, class_space_alignment);
1961 log_info(metaspace)("CDS initialization: reducing class space size from %zu to %zu",
1962 CompressedClassSpaceSize, class_space_size);
1963 FLAG_SET_ERGO(CompressedClassSpaceSize, class_space_size);
1964 }
1965
1966 const size_t total_range_size =
1967 archive_space_size + gap_size + class_space_size;
1968
1969 // Test that class space base address plus shift can be decoded by aarch64, when restored.
1970 const int precomputed_narrow_klass_shift = ArchiveBuilder::precomputed_narrow_klass_shift();
1971 if (!CompressedKlassPointers::check_klass_decode_mode(base_address, precomputed_narrow_klass_shift,
1972 total_range_size)) {
1973 aot_log_info(aot)("CDS initialization: Cannot use SharedBaseAddress " PTR_FORMAT " with precomputed shift %d.",
1974 p2i(base_address), precomputed_narrow_klass_shift);
1975 use_archive_base_addr = false;
1976 }
1977
1978 assert(total_range_size > ccs_begin_offset, "must be");
1979 if (use_windows_memory_mapping() && use_archive_base_addr) {
1980 if (base_address != nullptr) {
1981 // On Windows, we cannot safely split a reserved memory space into two (see JDK-8255917).
1982 // Hence, we optimistically reserve archive space and class space side-by-side. We only
1983 // do this for use_archive_base_addr=true since for use_archive_base_addr=false case
1984 // caller will not split the combined space for mapping, instead read the archive data
1985 // via sequential file IO.
1986 address ccs_base = base_address + archive_space_size + gap_size;
1987 archive_space_rs = MemoryReserver::reserve((char*)base_address,
1988 archive_space_size,
1989 archive_space_alignment,
1990 os::vm_page_size(),
1991 mtNone);
1992 class_space_rs = MemoryReserver::reserve((char*)ccs_base,
1993 class_space_size,
1994 class_space_alignment,
1995 os::vm_page_size(),
1996 mtNone);
1997 }
1998 if (!archive_space_rs.is_reserved() || !class_space_rs.is_reserved()) {
1999 release_reserved_spaces(total_space_rs, archive_space_rs, class_space_rs);
2000 return nullptr;
2001 }
2002 MemTracker::record_virtual_memory_tag(archive_space_rs, mtClassShared);
2003 MemTracker::record_virtual_memory_tag(class_space_rs, mtClass);
2004 } else {
2005 if (use_archive_base_addr && base_address != nullptr) {
2006 total_space_rs = MemoryReserver::reserve((char*) base_address,
2007 total_range_size,
2008 base_address_alignment,
2009 os::vm_page_size(),
2010 mtNone);
2011 } else {
2012 // We did not manage to reserve at the preferred address, or were instructed to relocate. In that
2013 // case we reserve wherever possible, but the start address needs to be encodable as narrow Klass
2014 // encoding base since the archived heap objects contain narrow Klass IDs pre-calculated toward the start
2015 // of the shared Metaspace. That prevents us from using zero-based encoding and therefore we won't
2016 // try allocating in low-address regions.
2017 total_space_rs = Metaspace::reserve_address_space_for_compressed_classes(total_range_size, false /* optimize_for_zero_base */);
2018 }
2019
2020 if (!total_space_rs.is_reserved()) {
2021 return nullptr;
2022 }
2023
2024 // Paranoid checks:
2025 assert(!use_archive_base_addr || (address)total_space_rs.base() == base_address,
2026 "Sanity (" PTR_FORMAT " vs " PTR_FORMAT ")", p2i(base_address), p2i(total_space_rs.base()));
2027 assert(is_aligned(total_space_rs.base(), base_address_alignment), "Sanity");
2028 assert(total_space_rs.size() == total_range_size, "Sanity");
2029
2030 // Now split up the space into ccs and cds archive. For simplicity, just leave
2031 // the gap reserved at the end of the archive space. Do not do real splitting.
2032 archive_space_rs = total_space_rs.first_part(ccs_begin_offset,
2033 (size_t)archive_space_alignment);
2034 class_space_rs = total_space_rs.last_part(ccs_begin_offset);
2035 MemTracker::record_virtual_memory_split_reserved(total_space_rs.base(), total_space_rs.size(),
2036 ccs_begin_offset, mtClassShared, mtClass);
2037 }
2038 assert(is_aligned(archive_space_rs.base(), archive_space_alignment), "Sanity");
2039 assert(is_aligned(archive_space_rs.size(), archive_space_alignment), "Sanity");
2040 assert(is_aligned(class_space_rs.base(), class_space_alignment), "Sanity");
2041 assert(is_aligned(class_space_rs.size(), class_space_alignment), "Sanity");
2042
2043
2044 return archive_space_rs.base();
2045
2046 #endif // INCLUDE_CLASS_SPACE
2047 }
2048
2049 void AOTMetaspace::release_reserved_spaces(ReservedSpace& total_space_rs,
2050 ReservedSpace& archive_space_rs,
2051 ReservedSpace& class_space_rs) {
2052 if (total_space_rs.is_reserved()) {
2053 aot_log_debug(aot)("Released shared space (archive + class) " INTPTR_FORMAT, p2i(total_space_rs.base()));
2054 MemoryReserver::release(total_space_rs);
2055 total_space_rs = {};
2056 } else {
2057 if (archive_space_rs.is_reserved()) {
2058 aot_log_debug(aot)("Released shared space (archive) " INTPTR_FORMAT, p2i(archive_space_rs.base()));
2059 MemoryReserver::release(archive_space_rs);
2060 archive_space_rs = {};
2061 }
2062 if (class_space_rs.is_reserved()) {
2063 aot_log_debug(aot)("Released shared space (classes) " INTPTR_FORMAT, p2i(class_space_rs.base()));
2064 MemoryReserver::release(class_space_rs);
2065 class_space_rs = {};
2066 }
2067 }
2068 }
2069
2070 static int archive_regions[] = { AOTMetaspace::rw, AOTMetaspace::ro };
2071 static int archive_regions_count = 2;
2072
2073 MapArchiveResult AOTMetaspace::map_archive(FileMapInfo* mapinfo, char* mapped_base_address, ReservedSpace rs) {
2074 assert(CDSConfig::is_using_archive(), "must be runtime");
2075 if (mapinfo == nullptr) {
2076 return MAP_ARCHIVE_SUCCESS; // The dynamic archive has not been specified. No error has happened -- trivially succeeded.
2077 }
2078
2079 mapinfo->set_is_mapped(false);
2080 if (mapinfo->core_region_alignment() != (size_t)core_region_alignment()) {
2081 report_loading_error("Unable to map CDS archive -- core_region_alignment() expected: %zu"
2082 " actual: %zu", mapinfo->core_region_alignment(), core_region_alignment());
2083 return MAP_ARCHIVE_OTHER_FAILURE;
2084 }
2085
2086 MapArchiveResult result =
2087 mapinfo->map_regions(archive_regions, archive_regions_count, mapped_base_address, rs);
2088
2089 if (result != MAP_ARCHIVE_SUCCESS) {
2090 unmap_archive(mapinfo);
2091 return result;
2092 }
2093
2094 if (!mapinfo->validate_class_location()) {
2095 unmap_archive(mapinfo);
2096 return MAP_ARCHIVE_OTHER_FAILURE;
2097 }
2098
2099 if (mapinfo->is_static()) {
2100 // Currently, only static archive uses early serialized data.
2101 char* buffer = mapinfo->early_serialized_data();
2102 intptr_t* array = (intptr_t*)buffer;
2103 ReadClosure rc(&array, (address)mapped_base_address);
2104 early_serialize(&rc);
2105 }
2106
2107 if (!mapinfo->validate_aot_class_linking()) {
2108 unmap_archive(mapinfo);
2109 return MAP_ARCHIVE_OTHER_FAILURE;
2110 }
2111
2112 mapinfo->set_is_mapped(true);
2113 return MAP_ARCHIVE_SUCCESS;
2114 }
2115
2116 void AOTMetaspace::unmap_archive(FileMapInfo* mapinfo) {
2117 assert(CDSConfig::is_using_archive(), "must be runtime");
2118 if (mapinfo != nullptr) {
2119 mapinfo->unmap_regions(archive_regions, archive_regions_count);
2120 mapinfo->unmap_region(AOTMetaspace::bm);
2121 mapinfo->set_is_mapped(false);
2122 }
2123 }
2124
2125 // For -XX:PrintSharedArchiveAndExit
2126 class CountSharedSymbols : public SymbolClosure {
2127 private:
2128 size_t _count;
2129 public:
2130 CountSharedSymbols() : _count(0) {}
2131 void do_symbol(Symbol** sym) {
2132 _count++;
2133 }
2134 size_t total() { return _count; }
2135
2136 };
2137
2138 // Read the miscellaneous data from the shared file, and
2139 // serialize it out to its various destinations.
2140
2141 void AOTMetaspace::initialize_shared_spaces() {
2142 FileMapInfo *static_mapinfo = FileMapInfo::current_info();
2143 FileMapInfo *dynamic_mapinfo = FileMapInfo::dynamic_info();
2144
2145 // Verify various attributes of the archive, plus initialize the
2146 // shared string/symbol tables.
2147 char* buffer = static_mapinfo->serialized_data();
2148 intptr_t* array = (intptr_t*)buffer;
2149 ReadClosure rc(&array, (address)SharedBaseAddress);
2150 serialize(&rc);
2151
2152 // Finish initializing the heap dump mode used in the archive
2153 // Heap initialization can be done only after vtables are initialized by ReadClosure.
2154 HeapShared::finalize_initialization(static_mapinfo);
2155 Universe::load_archived_object_instances();
2156
2157 AOTCodeCache::initialize();
2158
2159 if (dynamic_mapinfo != nullptr) {
2160 intptr_t* buffer = (intptr_t*)dynamic_mapinfo->serialized_data();
2161 ReadClosure rc(&buffer, (address)SharedBaseAddress);
2162 DynamicArchive::serialize(&rc);
2163 }
2164
2165 LogStreamHandle(Info, aot) lsh;
2166 if (lsh.is_enabled()) {
2167 lsh.print("Using AOT-linked classes: %s (static archive: %s aot-linked classes",
2168 BOOL_TO_STR(CDSConfig::is_using_aot_linked_classes()),
2169 static_mapinfo->header()->has_aot_linked_classes() ? "has" : "no");
2170 if (dynamic_mapinfo != nullptr) {
2171 lsh.print(", dynamic archive: %s aot-linked classes",
2172 dynamic_mapinfo->header()->has_aot_linked_classes() ? "has" : "no");
2173 }
2174 lsh.print_cr(")");
2175 }
2176
2177 // Set up LambdaFormInvokers::_lambdaform_lines for dynamic dump
2178 if (CDSConfig::is_dumping_dynamic_archive()) {
2179 // Read stored LF format lines stored in static archive
2180 LambdaFormInvokers::read_static_archive_invokers();
2181 }
2182
2183 if (PrintSharedArchiveAndExit) {
2184 // Print archive names
2185 if (dynamic_mapinfo != nullptr) {
2186 tty->print_cr("\n\nBase archive name: %s", CDSConfig::input_static_archive_path());
2187 tty->print_cr("Base archive version %d", static_mapinfo->version());
2188 } else {
2189 tty->print_cr("Static archive name: %s", static_mapinfo->full_path());
2190 tty->print_cr("Static archive version %d", static_mapinfo->version());
2191 }
2192
2193 SystemDictionaryShared::print_shared_archive(tty);
2194 if (dynamic_mapinfo != nullptr) {
2195 tty->print_cr("\n\nDynamic archive name: %s", dynamic_mapinfo->full_path());
2196 tty->print_cr("Dynamic archive version %d", dynamic_mapinfo->version());
2197 SystemDictionaryShared::print_shared_archive(tty, false/*dynamic*/);
2198 }
2199
2200 TrainingData::print_archived_training_data_on(tty);
2201
2202 AOTCodeCache::print_on(tty);
2203
2204 // collect shared symbols and strings
2205 CountSharedSymbols cl;
2206 SymbolTable::shared_symbols_do(&cl);
2207 tty->print_cr("Number of shared symbols: %zu", cl.total());
2208 if (HeapShared::is_loading() && HeapShared::is_loading_mapping_mode()) {
2209 tty->print_cr("Number of shared strings: %zu", StringTable::shared_entry_count());
2210 }
2211 tty->print_cr("VM version: %s\r\n", static_mapinfo->vm_version());
2212 if (FileMapInfo::current_info() == nullptr || _archive_loading_failed) {
2213 tty->print_cr("archive is invalid");
2214 vm_exit(1);
2215 } else {
2216 tty->print_cr("archive is valid");
2217 vm_exit(0);
2218 }
2219 }
2220 }
2221
2222 // JVM/TI RedefineClasses() support:
2223 bool AOTMetaspace::remap_shared_readonly_as_readwrite() {
2224 assert(SafepointSynchronize::is_at_safepoint(), "must be at safepoint");
2225
2226 if (CDSConfig::is_using_archive()) {
2227 // remap the shared readonly space to shared readwrite, private
2228 FileMapInfo* mapinfo = FileMapInfo::current_info();
2229 if (!mapinfo->remap_shared_readonly_as_readwrite()) {
2230 return false;
2231 }
2232 if (FileMapInfo::dynamic_info() != nullptr) {
2233 mapinfo = FileMapInfo::dynamic_info();
2234 if (!mapinfo->remap_shared_readonly_as_readwrite()) {
2235 return false;
2236 }
2237 }
2238 _remapped_readwrite = true;
2239 }
2240 return true;
2241 }
2242
2243 void AOTMetaspace::print_on(outputStream* st) {
2244 if (CDSConfig::is_using_archive()) {
2245 st->print("CDS archive(s) mapped at: ");
2246 address base = (address)MetaspaceObj::aot_metaspace_base();
2247 address static_top = (address)_aot_metaspace_static_top;
2248 address top = (address)MetaspaceObj::aot_metaspace_top();
2249 st->print("[" PTR_FORMAT "-" PTR_FORMAT "-" PTR_FORMAT "), ", p2i(base), p2i(static_top), p2i(top));
2250 st->print("size %zu, ", top - base);
2251 st->print("SharedBaseAddress: " PTR_FORMAT ", ArchiveRelocationMode: %d.", SharedBaseAddress, ArchiveRelocationMode);
2252 } else {
2253 st->print("CDS archive(s) not mapped");
2254 }
2255 st->cr();
2256 }