1 /*
2 * Copyright (c) 2012, 2023, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #include "precompiled.hpp"
26 #include "cds/archiveBuilder.hpp"
27 #include "cds/archiveHeapLoader.hpp"
28 #include "cds/archiveHeapWriter.hpp"
29 #include "cds/cds_globals.hpp"
30 #include "cds/cdsProtectionDomain.hpp"
31 #include "cds/classListWriter.hpp"
32 #include "cds/classListParser.hpp"
33 #include "cds/classPrelinker.hpp"
34 #include "cds/cppVtables.hpp"
35 #include "cds/dumpAllocStats.hpp"
36 #include "cds/filemap.hpp"
37 #include "cds/heapShared.hpp"
38 #include "cds/lambdaFormInvokers.hpp"
39 #include "cds/metaspaceShared.hpp"
40 #include "classfile/classLoaderDataGraph.hpp"
41 #include "classfile/classLoaderDataShared.hpp"
42 #include "classfile/classLoaderExt.hpp"
43 #include "classfile/javaClasses.inline.hpp"
44 #include "classfile/loaderConstraints.hpp"
45 #include "classfile/placeholders.hpp"
46 #include "classfile/symbolTable.hpp"
47 #include "classfile/stringTable.hpp"
48 #include "classfile/systemDictionary.hpp"
49 #include "classfile/systemDictionaryShared.hpp"
50 #include "classfile/vmClasses.hpp"
51 #include "classfile/vmSymbols.hpp"
52 #include "code/codeCache.hpp"
53 #include "gc/shared/gcVMOperations.hpp"
54 #include "interpreter/bytecodeStream.hpp"
55 #include "interpreter/bytecodes.hpp"
56 #include "jvm_io.h"
57 #include "logging/log.hpp"
58 #include "logging/logMessage.hpp"
59 #include "logging/logStream.hpp"
60 #include "memory/metaspace.hpp"
61 #include "memory/metaspaceClosure.hpp"
62 #include "memory/resourceArea.hpp"
63 #include "memory/universe.hpp"
64 #include "oops/compressedOops.inline.hpp"
65 #include "oops/flatArrayKlass.hpp"
66 #include "oops/inlineKlass.hpp"
67 #include "oops/instanceMirrorKlass.hpp"
68 #include "oops/klass.inline.hpp"
69 #include "oops/objArrayOop.hpp"
70 #include "oops/oop.inline.hpp"
71 #include "oops/oopHandle.hpp"
72 #include "prims/jvmtiExport.hpp"
73 #include "runtime/arguments.hpp"
74 #include "runtime/globals_extension.hpp"
75 #include "runtime/handles.inline.hpp"
76 #include "runtime/os.inline.hpp"
77 #include "runtime/safepointVerifiers.hpp"
78 #include "runtime/sharedRuntime.hpp"
79 #include "runtime/vmThread.hpp"
80 #include "runtime/vmOperations.hpp"
81 #include "sanitizers/leak.hpp"
82 #include "services/memTracker.hpp"
83 #include "utilities/align.hpp"
84 #include "utilities/bitMap.inline.hpp"
85 #include "utilities/ostream.hpp"
86 #include "utilities/defaultStream.hpp"
87 #include "utilities/resourceHash.hpp"
88
89 ReservedSpace MetaspaceShared::_symbol_rs;
90 VirtualSpace MetaspaceShared::_symbol_vs;
91 bool MetaspaceShared::_has_error_classes;
92 bool MetaspaceShared::_archive_loading_failed = false;
93 bool MetaspaceShared::_remapped_readwrite = false;
94 void* MetaspaceShared::_shared_metaspace_static_top = nullptr;
95 intx MetaspaceShared::_relocation_delta;
96 char* MetaspaceShared::_requested_base_address;
97 bool MetaspaceShared::_use_optimized_module_handling = true;
98 bool MetaspaceShared::_use_full_module_graph = true;
99
100 // The CDS archive is divided into the following regions:
101 // rw - read-write metadata
102 // ro - read-only metadata and read-only tables
103 // hp - heap region
104 // bm - bitmap for relocating the above 7 regions.
105 //
106 // The rw and ro regions are linearly allocated, in the order of rw->ro.
107 // These regions are aligned with MetaspaceShared::core_region_alignment().
108 //
109 // These 2 regions are populated in the following steps:
110 // [0] All classes are loaded in MetaspaceShared::preload_classes(). All metadata are
111 // temporarily allocated outside of the shared regions.
112 // [1] We enter a safepoint and allocate a buffer for the rw/ro regions.
113 // [2] C++ vtables are copied into the rw region.
114 // [3] ArchiveBuilder copies RW metadata into the rw region.
115 // [4] ArchiveBuilder copies RO metadata into the ro region.
116 // [5] SymbolTable, StringTable, SystemDictionary, and a few other read-only data
117 // are copied into the ro region as read-only tables.
118 //
119 // The heap region is populated by HeapShared::archive_objects.
120 //
121 // The bitmap region is used to relocate the ro/rw/hp regions.
122
123 static DumpRegion _symbol_region("symbols");
124
125 char* MetaspaceShared::symbol_space_alloc(size_t num_bytes) {
126 return _symbol_region.allocate(num_bytes);
127 }
128
129 // os::vm_allocation_granularity() is usually 4K for most OSes. However, some platforms
130 // such as linux-aarch64 and macos-x64 ...
131 // it can be either 4K or 64K and on macos-aarch64 it is 16K. To generate archives that are
132 // compatible for both settings, an alternative cds core region alignment can be enabled
133 // at building time:
134 // --enable-compactible-cds-alignment
135 // Upon successful configuration, the compactible alignment then can be defined in:
136 // os_linux_aarch64.cpp
137 // os_bsd_x86.cpp
138 size_t MetaspaceShared::core_region_alignment() {
139 return os::cds_core_region_alignment();
140 }
141
142 static bool shared_base_valid(char* shared_base) {
143 #ifdef _LP64
144 return CompressedKlassPointers::is_valid_base((address)shared_base);
145 #else
146 return true;
147 #endif
148 }
149
150 class DumpClassListCLDClosure : public CLDClosure {
151 static const int INITIAL_TABLE_SIZE = 1987;
152 static const int MAX_TABLE_SIZE = 61333;
153
154 fileStream *_stream;
155 ResizeableResourceHashtable<InstanceKlass*, bool,
156 AnyObj::C_HEAP, mtClassShared> _dumped_classes;
157
158 void dump(InstanceKlass* ik) {
159 bool created;
160 _dumped_classes.put_if_absent(ik, &created);
161 if (!created) {
162 return;
163 }
164 if (_dumped_classes.maybe_grow()) {
165 log_info(cds, hashtables)("Expanded _dumped_classes table to %d", _dumped_classes.table_size());
166 }
167 if (ik->java_super()) {
168 dump(ik->java_super());
169 }
170 Array<InstanceKlass*>* interfaces = ik->local_interfaces();
171 int len = interfaces->length();
172 for (int i = 0; i < len; i++) {
173 dump(interfaces->at(i));
174 }
175 ClassListWriter::write_to_stream(ik, _stream);
176 }
177
178 public:
179 DumpClassListCLDClosure(fileStream* f)
180 : CLDClosure(), _dumped_classes(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE) {
181 _stream = f;
182 }
183
184 void do_cld(ClassLoaderData* cld) {
185 for (Klass* klass = cld->klasses(); klass != nullptr; klass = klass->next_link()) {
186 if (klass->is_instance_klass()) {
187 dump(InstanceKlass::cast(klass));
188 }
189 }
190 }
191 };
192
193 void MetaspaceShared::dump_loaded_classes(const char* file_name, TRAPS) {
194 fileStream stream(file_name, "w");
195 if (stream.is_open()) {
196 MutexLocker lock(ClassLoaderDataGraph_lock);
197 MutexLocker lock2(ClassListFile_lock, Mutex::_no_safepoint_check_flag);
198 DumpClassListCLDClosure collect_classes(&stream);
199 ClassLoaderDataGraph::loaded_cld_do(&collect_classes);
200 } else {
201 THROW_MSG(vmSymbols::java_io_IOException(), "Failed to open file");
202 }
203 }
204
205 static bool shared_base_too_high(char* specified_base, char* aligned_base, size_t cds_max) {
206 if (specified_base != nullptr && aligned_base < specified_base) {
207 // SharedBaseAddress is very high (e.g., 0xffffffffffffff00) so
208 // align_up(SharedBaseAddress, MetaspaceShared::core_region_alignment()) has wrapped around.
209 return true;
210 }
211 if (max_uintx - uintx(aligned_base) < uintx(cds_max)) {
212 // The end of the archive will wrap around
213 return true;
214 }
215
216 return false;
217 }
218
219 static char* compute_shared_base(size_t cds_max) {
220 char* specified_base = (char*)SharedBaseAddress;
221 char* aligned_base = align_up(specified_base, MetaspaceShared::core_region_alignment());
222
223 const char* err = nullptr;
224 if (shared_base_too_high(specified_base, aligned_base, cds_max)) {
225 err = "too high";
226 } else if (!shared_base_valid(aligned_base)) {
227 err = "invalid for this platform";
228 } else {
229 return aligned_base;
230 }
231
232 log_warning(cds)("SharedBaseAddress (" INTPTR_FORMAT ") is %s. Reverted to " INTPTR_FORMAT,
233 p2i((void*)SharedBaseAddress), err,
234 p2i((void*)Arguments::default_SharedBaseAddress()));
235
236 specified_base = (char*)Arguments::default_SharedBaseAddress();
237 aligned_base = align_up(specified_base, MetaspaceShared::core_region_alignment());
238
239 // Make sure the default value of SharedBaseAddress specified in globals.hpp is sane.
240 assert(!shared_base_too_high(specified_base, aligned_base, cds_max), "Sanity");
241 assert(shared_base_valid(aligned_base), "Sanity");
242 return aligned_base;
243 }
244
245 void MetaspaceShared::initialize_for_static_dump() {
246 assert(DumpSharedSpaces, "should be called for dump time only");
247 log_info(cds)("Core region alignment: " SIZE_FORMAT, core_region_alignment());
248 // The max allowed size for CDS archive. We use this to limit SharedBaseAddress
249 // to avoid address space wrap around.
250 size_t cds_max;
251 const size_t reserve_alignment = core_region_alignment();
252
253 #ifdef _LP64
254 const uint64_t UnscaledClassSpaceMax = (uint64_t(max_juint) + 1);
255 cds_max = align_down(UnscaledClassSpaceMax, reserve_alignment);
256 #else
257 // We don't support archives larger than 256MB on 32-bit due to limited
258 // virtual address space.
259 cds_max = align_down(256*M, reserve_alignment);
260 #endif
261
262 _requested_base_address = compute_shared_base(cds_max);
263 SharedBaseAddress = (size_t)_requested_base_address;
264
265 size_t symbol_rs_size = LP64_ONLY(3 * G) NOT_LP64(128 * M);
266 _symbol_rs = ReservedSpace(symbol_rs_size);
267 if (!_symbol_rs.is_reserved()) {
268 log_error(cds)("Unable to reserve memory for symbols: " SIZE_FORMAT " bytes.", symbol_rs_size);
269 MetaspaceShared::unrecoverable_writing_error();
270 }
271 _symbol_region.init(&_symbol_rs, &_symbol_vs);
272 }
273
274 // Called by universe_post_init()
275 void MetaspaceShared::post_initialize(TRAPS) {
276 if (UseSharedSpaces) {
277 int size = FileMapInfo::get_number_of_shared_paths();
278 if (size > 0) {
279 CDSProtectionDomain::allocate_shared_data_arrays(size, CHECK);
280 if (!DynamicDumpSharedSpaces) {
281 FileMapInfo* info;
282 if (FileMapInfo::dynamic_info() == nullptr) {
283 info = FileMapInfo::current_info();
284 } else {
285 info = FileMapInfo::dynamic_info();
286 }
287 ClassLoaderExt::init_paths_start_index(info->app_class_paths_start_index());
288 ClassLoaderExt::init_app_module_paths_start_index(info->app_module_paths_start_index());
289 }
290 }
291 }
292 }
293
294 static GrowableArrayCHeap<OopHandle, mtClassShared>* _extra_interned_strings = nullptr;
295 static GrowableArrayCHeap<Symbol*, mtClassShared>* _extra_symbols = nullptr;
296
297 void MetaspaceShared::read_extra_data(JavaThread* current, const char* filename) {
298 _extra_interned_strings = new GrowableArrayCHeap<OopHandle, mtClassShared>(10000);
299 _extra_symbols = new GrowableArrayCHeap<Symbol*, mtClassShared>(1000);
300
301 HashtableTextDump reader(filename);
302 reader.check_version("VERSION: 1.0");
303
304 while (reader.remain() > 0) {
305 int utf8_length;
306 int prefix_type = reader.scan_prefix(&utf8_length);
307 ResourceMark rm(current);
308 if (utf8_length == 0x7fffffff) {
309 // buf_len will overflown 32-bit value.
310 log_error(cds)("string length too large: %d", utf8_length);
311 MetaspaceShared::unrecoverable_loading_error();
312 }
313 int buf_len = utf8_length+1;
314 char* utf8_buffer = NEW_RESOURCE_ARRAY(char, buf_len);
315 reader.get_utf8(utf8_buffer, utf8_length);
316 utf8_buffer[utf8_length] = '\0';
317
318 if (prefix_type == HashtableTextDump::SymbolPrefix) {
319 _extra_symbols->append(SymbolTable::new_permanent_symbol(utf8_buffer));
320 } else{
321 assert(prefix_type == HashtableTextDump::StringPrefix, "Sanity");
322 ExceptionMark em(current);
323 JavaThread* THREAD = current; // For exception macros.
324 oop str = StringTable::intern(utf8_buffer, THREAD);
325
326 if (HAS_PENDING_EXCEPTION) {
327 log_warning(cds, heap)("[line %d] extra interned string allocation failed; size too large: %d",
328 reader.last_line_no(), utf8_length);
329 CLEAR_PENDING_EXCEPTION;
330 } else {
331 #if INCLUDE_CDS_JAVA_HEAP
332 if (ArchiveHeapWriter::is_string_too_large_to_archive(str)) {
333 log_warning(cds, heap)("[line %d] extra interned string ignored; size too large: %d",
334 reader.last_line_no(), utf8_length);
335 continue;
336 }
337 // Make sure this string is included in the dumped interned string table.
338 assert(str != nullptr, "must succeed");
339 _extra_interned_strings->append(OopHandle(Universe::vm_global(), str));
340 #endif
341 }
342 }
343 }
344 }
345
346 // Read/write a data stream for restoring/preserving metadata pointers and
347 // miscellaneous data from/to the shared archive file.
348
349 void MetaspaceShared::serialize(SerializeClosure* soc) {
350 int tag = 0;
351 soc->do_tag(--tag);
352
353 // Verify the sizes of various metadata in the system.
354 soc->do_tag(sizeof(Method));
355 soc->do_tag(sizeof(ConstMethod));
356 soc->do_tag(arrayOopDesc::base_offset_in_bytes(T_BYTE));
357 soc->do_tag(sizeof(ConstantPool));
358 soc->do_tag(sizeof(ConstantPoolCache));
359 soc->do_tag(objArrayOopDesc::base_offset_in_bytes());
360 soc->do_tag(typeArrayOopDesc::base_offset_in_bytes(T_BYTE));
361 soc->do_tag(sizeof(Symbol));
362
363 // Need to do this first, as subsequent steps may call virtual functions
364 // in archived Metadata objects.
365 CppVtables::serialize(soc);
366 soc->do_tag(--tag);
367
368 // Dump/restore miscellaneous metadata.
369 JavaClasses::serialize_offsets(soc);
370 HeapShared::serialize_root(soc);
371 Universe::serialize(soc);
372 soc->do_tag(--tag);
373
374 // Dump/restore references to commonly used names and signatures.
375 vmSymbols::serialize(soc);
376 soc->do_tag(--tag);
377
378 // Dump/restore the symbol/string/subgraph_info tables
379 SymbolTable::serialize_shared_table_header(soc);
380 StringTable::serialize_shared_table_header(soc);
381 HeapShared::serialize_tables(soc);
382 SystemDictionaryShared::serialize_dictionary_headers(soc);
383
384 InstanceMirrorKlass::serialize_offsets(soc);
385
386 // Dump/restore well known classes (pointers)
387 SystemDictionaryShared::serialize_vm_classes(soc);
388 soc->do_tag(--tag);
389
390 CDS_JAVA_HEAP_ONLY(ClassLoaderDataShared::serialize(soc);)
391
392 LambdaFormInvokers::serialize(soc);
393 soc->do_tag(666);
394 }
395
396 static void rewrite_nofast_bytecode(const methodHandle& method) {
397 BytecodeStream bcs(method);
398 while (!bcs.is_last_bytecode()) {
399 Bytecodes::Code opcode = bcs.next();
400 switch (opcode) {
401 case Bytecodes::_getfield: *bcs.bcp() = Bytecodes::_nofast_getfield; break;
402 case Bytecodes::_putfield: *bcs.bcp() = Bytecodes::_nofast_putfield; break;
403 case Bytecodes::_aload_0: *bcs.bcp() = Bytecodes::_nofast_aload_0; break;
404 case Bytecodes::_iload: {
405 if (!bcs.is_wide()) {
406 *bcs.bcp() = Bytecodes::_nofast_iload;
407 }
408 break;
409 }
410 default: break;
411 }
412 }
413 }
414
415 // [1] Rewrite all bytecodes as needed, so that the ConstMethod* will not be modified
416 // at run time by RewriteBytecodes/RewriteFrequentPairs
417 // [2] Assign a fingerprint, so one doesn't need to be assigned at run-time.
418 void MetaspaceShared::rewrite_nofast_bytecodes_and_calculate_fingerprints(Thread* thread, InstanceKlass* ik) {
419 for (int i = 0; i < ik->methods()->length(); i++) {
420 methodHandle m(thread, ik->methods()->at(i));
421 if (ik->can_be_verified_at_dumptime() && ik->is_linked()) {
422 rewrite_nofast_bytecode(m);
423 }
424 Fingerprinter fp(m);
425 // The side effect of this call sets method's fingerprint field.
426 fp.fingerprint();
427 }
428 }
429
430 class VM_PopulateDumpSharedSpace : public VM_Operation {
431 private:
432 ArchiveHeapInfo _heap_info;
433
434 void dump_java_heap_objects(GrowableArray<Klass*>* klasses) NOT_CDS_JAVA_HEAP_RETURN;
435 void dump_shared_symbol_table(GrowableArray<Symbol*>* symbols) {
436 log_info(cds)("Dumping symbol table ...");
437 SymbolTable::write_to_archive(symbols);
438 }
439 char* dump_read_only_tables();
440
441 public:
442
443 VM_PopulateDumpSharedSpace() : VM_Operation(), _heap_info() {}
444
445 bool skip_operation() const { return false; }
446
447 VMOp_Type type() const { return VMOp_PopulateDumpSharedSpace; }
448 void doit(); // outline because gdb sucks
449 bool allow_nested_vm_operations() const { return true; }
450 }; // class VM_PopulateDumpSharedSpace
451
452 class StaticArchiveBuilder : public ArchiveBuilder {
453 public:
454 StaticArchiveBuilder() : ArchiveBuilder() {}
455
456 virtual void iterate_roots(MetaspaceClosure* it) {
457 FileMapInfo::metaspace_pointers_do(it);
458 SystemDictionaryShared::dumptime_classes_do(it);
459 Universe::metaspace_pointers_do(it);
460 vmSymbols::metaspace_pointers_do(it);
461
462 // The above code should find all the symbols that are referenced by the
463 // archived classes. We just need to add the extra symbols which
464 // may not be used by any of the archived classes -- these are usually
465 // symbols that we anticipate to be used at run time, so we can store
466 // them in the RO region, to be shared across multiple processes.
467 if (_extra_symbols != nullptr) {
468 for (int i = 0; i < _extra_symbols->length(); i++) {
469 it->push(_extra_symbols->adr_at(i));
470 }
471 }
472 }
473 };
474
475 char* VM_PopulateDumpSharedSpace::dump_read_only_tables() {
476 ArchiveBuilder::OtherROAllocMark mark;
477
478 SystemDictionaryShared::write_to_archive();
479
480 // Write lambform lines into archive
481 LambdaFormInvokers::dump_static_archive_invokers();
482 // Write the other data to the output array.
483 DumpRegion* ro_region = ArchiveBuilder::current()->ro_region();
484 char* start = ro_region->top();
485 WriteClosure wc(ro_region);
486 MetaspaceShared::serialize(&wc);
487
488 return start;
489 }
490
491 void VM_PopulateDumpSharedSpace::doit() {
492 DEBUG_ONLY(SystemDictionaryShared::NoClassLoadingMark nclm);
493
494 FileMapInfo::check_nonempty_dir_in_shared_path_table();
495
496 NOT_PRODUCT(SystemDictionary::verify();)
497
498 // Block concurrent class unloading from changing the _dumptime_table
499 MutexLocker ml(DumpTimeTable_lock, Mutex::_no_safepoint_check_flag);
500 SystemDictionaryShared::check_excluded_classes();
501
502 StaticArchiveBuilder builder;
503 builder.gather_source_objs();
504 builder.reserve_buffer();
505
506 char* cloned_vtables = CppVtables::dumptime_init(&builder);
507
508 builder.dump_rw_metadata();
509 builder.dump_ro_metadata();
510 builder.relocate_metaspaceobj_embedded_pointers();
511
512 dump_java_heap_objects(builder.klasses());
513 dump_shared_symbol_table(builder.symbols());
514
515 log_info(cds)("Make classes shareable");
516 builder.make_klasses_shareable();
517
518 char* serialized_data = dump_read_only_tables();
519
520 SystemDictionaryShared::adjust_lambda_proxy_class_dictionary();
521
522 // The vtable clones contain addresses of the current process.
523 // We don't want to write these addresses into the archive.
524 CppVtables::zero_archived_vtables();
525
526 // relocate the data so that it can be mapped to MetaspaceShared::requested_base_address()
527 // without runtime relocation.
528 builder.relocate_to_requested();
529
530 // Write the archive file
531 const char* static_archive = Arguments::GetSharedArchivePath();
532 assert(static_archive != nullptr, "SharedArchiveFile not set?");
533 FileMapInfo* mapinfo = new FileMapInfo(static_archive, true);
534 mapinfo->populate_header(MetaspaceShared::core_region_alignment());
535 mapinfo->set_serialized_data(serialized_data);
536 mapinfo->set_cloned_vtables(cloned_vtables);
537 mapinfo->open_for_write();
538 builder.write_archive(mapinfo, &_heap_info);
539
540 if (PrintSystemDictionaryAtExit) {
541 SystemDictionary::print();
542 }
543
544 if (AllowArchivingWithJavaAgent) {
545 log_warning(cds)("This archive was created with AllowArchivingWithJavaAgent. It should be used "
546 "for testing purposes only and should not be used in a production environment");
547 }
548
549 MetaspaceShared::exit_after_static_dump();
550 }
551
552 class CollectCLDClosure : public CLDClosure {
553 GrowableArray<ClassLoaderData*> _loaded_cld;
554 GrowableArray<OopHandle> _loaded_cld_handles; // keep the CLDs alive
555 Thread* _current_thread;
556 public:
557 CollectCLDClosure(Thread* thread) : _current_thread(thread) {}
558 ~CollectCLDClosure() {
559 for (int i = 0; i < _loaded_cld_handles.length(); i++) {
560 _loaded_cld_handles.at(i).release(Universe::vm_global());
561 }
562 }
563 void do_cld(ClassLoaderData* cld) {
564 assert(cld->is_alive(), "must be");
565 _loaded_cld.append(cld);
566 _loaded_cld_handles.append(OopHandle(Universe::vm_global(), cld->holder()));
567 }
568
569 int nof_cld() const { return _loaded_cld.length(); }
570 ClassLoaderData* cld_at(int index) { return _loaded_cld.at(index); }
571 };
572
573 // Check if we can eagerly link this class at dump time, so we can avoid the
574 // runtime linking overhead (especially verification)
575 bool MetaspaceShared::may_be_eagerly_linked(InstanceKlass* ik) {
576 if (!ik->can_be_verified_at_dumptime()) {
577 // For old classes, try to leave them in the unlinked state, so
578 // we can still store them in the archive. They must be
579 // linked/verified at runtime.
580 return false;
581 }
582 if (DynamicDumpSharedSpaces && ik->is_shared_unregistered_class()) {
583 // Linking of unregistered classes at this stage may cause more
584 // classes to be resolved, resulting in calls to ClassLoader.loadClass()
585 // that may not be expected by custom class loaders.
586 //
587 // It's OK to do this for the built-in loaders as we know they can
588 // tolerate this.
589 return false;
590 }
591 return true;
592 }
593
594 bool MetaspaceShared::link_class_for_cds(InstanceKlass* ik, TRAPS) {
595 // Link the class to cause the bytecodes to be rewritten and the
596 // cpcache to be created. Class verification is done according
597 // to -Xverify setting.
598 bool res = MetaspaceShared::try_link_class(THREAD, ik);
599 ClassPrelinker::dumptime_resolve_constants(ik, CHECK_(false));
600 return res;
601 }
602
603 void MetaspaceShared::link_shared_classes(bool jcmd_request, TRAPS) {
604 ClassPrelinker::initialize();
605
606 if (!jcmd_request) {
607 LambdaFormInvokers::regenerate_holder_classes(CHECK);
608 }
609
610 // Collect all loaded ClassLoaderData.
611 CollectCLDClosure collect_cld(THREAD);
612 {
613 // ClassLoaderDataGraph::loaded_cld_do requires ClassLoaderDataGraph_lock.
614 // We cannot link the classes while holding this lock (or else we may run into deadlock).
615 // Therefore, we need to first collect all the CLDs, and then link their classes after
616 // releasing the lock.
617 MutexLocker lock(ClassLoaderDataGraph_lock);
618 ClassLoaderDataGraph::loaded_cld_do(&collect_cld);
619 }
620
621 while (true) {
622 bool has_linked = false;
623 for (int i = 0; i < collect_cld.nof_cld(); i++) {
624 ClassLoaderData* cld = collect_cld.cld_at(i);
625 for (Klass* klass = cld->klasses(); klass != nullptr; klass = klass->next_link()) {
626 if (klass->is_instance_klass()) {
627 InstanceKlass* ik = InstanceKlass::cast(klass);
628 if (may_be_eagerly_linked(ik)) {
629 has_linked |= link_class_for_cds(ik, CHECK);
630 }
631 }
632 }
633 }
634
635 if (!has_linked) {
636 break;
637 }
638 // Class linking includes verification which may load more classes.
639 // Keep scanning until we have linked no more classes.
640 }
641 }
642
643 void MetaspaceShared::prepare_for_dumping() {
644 Arguments::assert_is_dumping_archive();
645 Arguments::check_unsupported_dumping_properties();
646
647 ClassLoader::initialize_shared_path(JavaThread::current());
648 }
649
650 // Preload classes from a list, populate the shared spaces and dump to a
651 // file.
652 void MetaspaceShared::preload_and_dump() {
653 EXCEPTION_MARK;
654 ResourceMark rm(THREAD);
655 preload_and_dump_impl(THREAD);
656 if (HAS_PENDING_EXCEPTION) {
657 if (PENDING_EXCEPTION->is_a(vmClasses::OutOfMemoryError_klass())) {
658 log_error(cds)("Out of memory. Please run with a larger Java heap, current MaxHeapSize = "
659 SIZE_FORMAT "M", MaxHeapSize/M);
660 MetaspaceShared::unrecoverable_writing_error();
661 } else {
662 log_error(cds)("%s: %s", PENDING_EXCEPTION->klass()->external_name(),
663 java_lang_String::as_utf8_string(java_lang_Throwable::message(PENDING_EXCEPTION)));
664 MetaspaceShared::unrecoverable_writing_error("VM exits due to exception, use -Xlog:cds,exceptions=trace for detail");
665 }
666 } else {
667 // On success, the VM_PopulateDumpSharedSpace op should have
668 // exited the VM.
669 ShouldNotReachHere();
670 }
671 }
672
673 #if INCLUDE_CDS_JAVA_HEAP && defined(_LP64)
674 void MetaspaceShared::adjust_heap_sizes_for_dumping() {
675 if (!DumpSharedSpaces || UseCompressedOops) {
676 return;
677 }
678 // CDS heap dumping requires all string oops to have an offset
679 // from the heap bottom that can be encoded in 32-bit.
680 julong max_heap_size = (julong)(4 * G);
681
682 if (MinHeapSize > max_heap_size) {
683 log_debug(cds)("Setting MinHeapSize to 4G for CDS dumping, original size = " SIZE_FORMAT "M", MinHeapSize/M);
684 FLAG_SET_ERGO(MinHeapSize, max_heap_size);
685 }
686 if (InitialHeapSize > max_heap_size) {
687 log_debug(cds)("Setting InitialHeapSize to 4G for CDS dumping, original size = " SIZE_FORMAT "M", InitialHeapSize/M);
688 FLAG_SET_ERGO(InitialHeapSize, max_heap_size);
689 }
690 if (MaxHeapSize > max_heap_size) {
691 log_debug(cds)("Setting MaxHeapSize to 4G for CDS dumping, original size = " SIZE_FORMAT "M", MaxHeapSize/M);
692 FLAG_SET_ERGO(MaxHeapSize, max_heap_size);
693 }
694 }
695 #endif // INCLUDE_CDS_JAVA_HEAP && _LP64
696
697 void MetaspaceShared::get_default_classlist(char* default_classlist, const size_t buf_size) {
698 // Construct the path to the class list (in jre/lib)
699 // Walk up two directories from the location of the VM and
700 // optionally tack on "lib" (depending on platform)
701 os::jvm_path(default_classlist, (jint)(buf_size));
702 for (int i = 0; i < 3; i++) {
703 char *end = strrchr(default_classlist, *os::file_separator());
704 if (end != nullptr) *end = '\0';
705 }
706 size_t classlist_path_len = strlen(default_classlist);
707 if (classlist_path_len >= 3) {
708 if (strcmp(default_classlist + classlist_path_len - 3, "lib") != 0) {
709 if (classlist_path_len < buf_size - 4) {
710 jio_snprintf(default_classlist + classlist_path_len,
711 buf_size - classlist_path_len,
712 "%slib", os::file_separator());
713 classlist_path_len += 4;
714 }
715 }
716 }
717 if (classlist_path_len < buf_size - 10) {
718 jio_snprintf(default_classlist + classlist_path_len,
719 buf_size - classlist_path_len,
720 "%sclasslist", os::file_separator());
721 }
722 }
723
724 void MetaspaceShared::preload_classes(TRAPS) {
725 char default_classlist[JVM_MAXPATHLEN];
726 const char* classlist_path;
727
728 get_default_classlist(default_classlist, sizeof(default_classlist));
729 if (SharedClassListFile == nullptr) {
730 classlist_path = default_classlist;
731 } else {
732 classlist_path = SharedClassListFile;
733 }
734
735 log_info(cds)("Loading classes to share ...");
736 _has_error_classes = false;
737 int class_count = ClassListParser::parse_classlist(classlist_path,
738 ClassListParser::_parse_all, CHECK);
739 if (ExtraSharedClassListFile) {
740 class_count += ClassListParser::parse_classlist(ExtraSharedClassListFile,
741 ClassListParser::_parse_all, CHECK);
742 }
743 if (classlist_path != default_classlist) {
744 struct stat statbuf;
745 if (os::stat(default_classlist, &statbuf) == 0) {
746 // File exists, let's use it.
747 class_count += ClassListParser::parse_classlist(default_classlist,
748 ClassListParser::_parse_lambda_forms_invokers_only, CHECK);
749 }
750 }
751
752 // Exercise the manifest processing code to ensure classes used by CDS at runtime
753 // are always archived
754 const char* dummy = "Manifest-Version: 1.0\n";
755 CDSProtectionDomain::create_jar_manifest(dummy, strlen(dummy), CHECK);
756
757 log_info(cds)("Loading classes to share: done.");
758 log_info(cds)("Shared spaces: preloaded %d classes", class_count);
759 }
760
761 void MetaspaceShared::preload_and_dump_impl(TRAPS) {
762 preload_classes(CHECK);
763
764 if (SharedArchiveConfigFile) {
765 log_info(cds)("Reading extra data from %s ...", SharedArchiveConfigFile);
766 read_extra_data(THREAD, SharedArchiveConfigFile);
767 log_info(cds)("Reading extra data: done.");
768 }
769
770 HeapShared::init_for_dumping(CHECK);
771
772 // Rewrite and link classes
773 log_info(cds)("Rewriting and linking classes ...");
774
775 // Link any classes which got missed. This would happen if we have loaded classes that
776 // were not explicitly specified in the classlist. E.g., if an interface implemented by class K
777 // fails verification, all other interfaces that were not specified in the classlist but
778 // are implemented by K are not verified.
779 link_shared_classes(false/*not from jcmd*/, CHECK);
780 log_info(cds)("Rewriting and linking classes: done");
781
782 #if INCLUDE_CDS_JAVA_HEAP
783 StringTable::allocate_shared_strings_array(CHECK);
784 ArchiveHeapWriter::init();
785 if (use_full_module_graph()) {
786 HeapShared::reset_archived_object_states(CHECK);
787 }
788 #endif
789
790 VM_PopulateDumpSharedSpace op;
791 VMThread::execute(&op);
792 }
793
794 // Returns true if the class's status has changed.
795 bool MetaspaceShared::try_link_class(JavaThread* current, InstanceKlass* ik) {
796 ExceptionMark em(current);
797 JavaThread* THREAD = current; // For exception macros.
798 Arguments::assert_is_dumping_archive();
799 if (ik->is_loaded() && !ik->is_linked() && ik->can_be_verified_at_dumptime() &&
800 !SystemDictionaryShared::has_class_failed_verification(ik)) {
801 bool saved = BytecodeVerificationLocal;
802 if (ik->is_shared_unregistered_class() && ik->class_loader() == nullptr) {
803 // The verification decision is based on BytecodeVerificationRemote
804 // for non-system classes. Since we are using the null classloader
805 // to load non-system classes for customized class loaders during dumping,
806 // we need to temporarily change BytecodeVerificationLocal to be the same as
807 // BytecodeVerificationRemote. Note this can cause the parent system
808 // classes also being verified. The extra overhead is acceptable during
809 // dumping.
810 BytecodeVerificationLocal = BytecodeVerificationRemote;
811 }
812 ik->link_class(THREAD);
813 if (HAS_PENDING_EXCEPTION) {
814 ResourceMark rm(THREAD);
815 log_warning(cds)("Preload Warning: Verification failed for %s",
816 ik->external_name());
817 CLEAR_PENDING_EXCEPTION;
818 SystemDictionaryShared::set_class_has_failed_verification(ik);
819 _has_error_classes = true;
820 }
821 ik->compute_has_loops_flag_for_methods();
822 BytecodeVerificationLocal = saved;
823 return true;
824 } else {
825 return false;
826 }
827 }
828
829 #if INCLUDE_CDS_JAVA_HEAP
830 void VM_PopulateDumpSharedSpace::dump_java_heap_objects(GrowableArray<Klass*>* klasses) {
831 if(!HeapShared::can_write()) {
832 log_info(cds)(
833 "Archived java heap is not supported as UseG1GC "
834 "and UseCompressedClassPointers are required."
835 "Current settings: UseG1GC=%s, UseCompressedClassPointers=%s.",
836 BOOL_TO_STR(UseG1GC), BOOL_TO_STR(UseCompressedClassPointers));
837 return;
838 }
839 // Find all the interned strings that should be dumped.
840 int i;
841 for (i = 0; i < klasses->length(); i++) {
842 Klass* k = klasses->at(i);
843 if (k->is_instance_klass()) {
844 InstanceKlass* ik = InstanceKlass::cast(k);
845 if (ik->is_linked()) {
846 ik->constants()->add_dumped_interned_strings();
847 }
848 }
849 }
850 if (_extra_interned_strings != nullptr) {
851 for (i = 0; i < _extra_interned_strings->length(); i ++) {
852 OopHandle string = _extra_interned_strings->at(i);
853 HeapShared::add_to_dumped_interned_strings(string.resolve());
854 }
855 }
856
857 HeapShared::archive_objects(&_heap_info);
858 ArchiveBuilder::OtherROAllocMark mark;
859 HeapShared::write_subgraph_info_table();
860 }
861 #endif // INCLUDE_CDS_JAVA_HEAP
862
863 void MetaspaceShared::set_shared_metaspace_range(void* base, void *static_top, void* top) {
864 assert(base <= static_top && static_top <= top, "must be");
865 _shared_metaspace_static_top = static_top;
866 MetaspaceObj::set_shared_metaspace_range(base, top);
867 }
868
869 bool MetaspaceShared::is_shared_dynamic(void* p) {
870 if ((p < MetaspaceObj::shared_metaspace_top()) &&
871 (p >= _shared_metaspace_static_top)) {
872 return true;
873 } else {
874 return false;
875 }
876 }
877
878 // This function is called when the JVM is unable to load the specified archive(s) due to one
879 // of the following conditions.
880 // - There's an error that indicates that the archive(s) files were corrupt or otherwise damaged.
881 // - When -XX:+RequireSharedSpaces is specified, AND the JVM cannot load the archive(s) due
882 // to version or classpath mismatch.
883 void MetaspaceShared::unrecoverable_loading_error(const char* message) {
884 log_error(cds)("An error has occurred while processing the shared archive file.");
885 if (message != nullptr) {
886 log_error(cds)("%s", message);
887 }
888 vm_exit_during_initialization("Unable to use shared archive.", nullptr);
889 }
890
891 // This function is called when the JVM is unable to write the specified CDS archive due to an
892 // unrecoverable error.
893 void MetaspaceShared::unrecoverable_writing_error(const char* message) {
894 log_error(cds)("An error has occurred while writing the shared archive file.");
895 if (message != nullptr) {
896 log_error(cds)("%s", message);
897 }
898 vm_direct_exit(1);
899 }
900
901 // We have finished dumping the static archive. At this point, there may be pending VM
902 // operations. We have changed some global states (such as vmClasses::_klasses) that
903 // may cause these VM operations to fail. For safety, forget these operations and
904 // exit the VM directly.
905 void MetaspaceShared::exit_after_static_dump() {
906 os::_exit(0);
907 }
908
909 void MetaspaceShared::initialize_runtime_shared_and_meta_spaces() {
910 assert(UseSharedSpaces, "Must be called when UseSharedSpaces is enabled");
911 MapArchiveResult result = MAP_ARCHIVE_OTHER_FAILURE;
912
913 FileMapInfo* static_mapinfo = open_static_archive();
914 FileMapInfo* dynamic_mapinfo = nullptr;
915
916 if (static_mapinfo != nullptr) {
917 log_info(cds)("Core region alignment: " SIZE_FORMAT, static_mapinfo->core_region_alignment());
918 dynamic_mapinfo = open_dynamic_archive();
919
920 // First try to map at the requested address
921 result = map_archives(static_mapinfo, dynamic_mapinfo, true);
922 if (result == MAP_ARCHIVE_MMAP_FAILURE) {
923 // Mapping has failed (probably due to ASLR). Let's map at an address chosen
924 // by the OS.
925 log_info(cds)("Try to map archive(s) at an alternative address");
926 result = map_archives(static_mapinfo, dynamic_mapinfo, false);
927 }
928 }
929
930 if (result == MAP_ARCHIVE_SUCCESS) {
931 bool dynamic_mapped = (dynamic_mapinfo != nullptr && dynamic_mapinfo->is_mapped());
932 char* cds_base = static_mapinfo->mapped_base();
933 char* cds_end = dynamic_mapped ? dynamic_mapinfo->mapped_end() : static_mapinfo->mapped_end();
934 // Register CDS memory region with LSan.
935 LSAN_REGISTER_ROOT_REGION(cds_base, cds_end - cds_base);
936 set_shared_metaspace_range(cds_base, static_mapinfo->mapped_end(), cds_end);
937 _relocation_delta = static_mapinfo->relocation_delta();
938 _requested_base_address = static_mapinfo->requested_base_address();
939 if (dynamic_mapped) {
940 FileMapInfo::set_shared_path_table(dynamic_mapinfo);
941 // turn AutoCreateSharedArchive off if successfully mapped
942 AutoCreateSharedArchive = false;
943 } else {
944 FileMapInfo::set_shared_path_table(static_mapinfo);
945 }
946 } else {
947 set_shared_metaspace_range(nullptr, nullptr, nullptr);
948 if (DynamicDumpSharedSpaces) {
949 log_warning(cds)("-XX:ArchiveClassesAtExit is unsupported when base CDS archive is not loaded. Run with -Xlog:cds for more info.");
950 }
951 UseSharedSpaces = false;
952 // The base archive cannot be mapped. We cannot dump the dynamic shared archive.
953 AutoCreateSharedArchive = false;
954 DynamicDumpSharedSpaces = false;
955 log_info(cds)("Unable to map shared spaces");
956 if (PrintSharedArchiveAndExit) {
957 MetaspaceShared::unrecoverable_loading_error("Unable to use shared archive.");
958 } else if (RequireSharedSpaces) {
959 MetaspaceShared::unrecoverable_loading_error("Unable to map shared spaces");
960 }
961 }
962
963 // If mapping failed and -XShare:on, the vm should exit
964 bool has_failed = false;
965 if (static_mapinfo != nullptr && !static_mapinfo->is_mapped()) {
966 has_failed = true;
967 delete static_mapinfo;
968 }
969 if (dynamic_mapinfo != nullptr && !dynamic_mapinfo->is_mapped()) {
970 has_failed = true;
971 delete dynamic_mapinfo;
972 }
973 if (RequireSharedSpaces && has_failed) {
974 MetaspaceShared::unrecoverable_loading_error("Unable to map shared spaces");
975 }
976 }
977
978 FileMapInfo* MetaspaceShared::open_static_archive() {
979 const char* static_archive = Arguments::GetSharedArchivePath();
980 assert(static_archive != nullptr, "SharedArchivePath is nullptr");
981 FileMapInfo* mapinfo = new FileMapInfo(static_archive, true);
982 if (!mapinfo->initialize()) {
983 delete(mapinfo);
984 return nullptr;
985 }
986 return mapinfo;
987 }
988
989 FileMapInfo* MetaspaceShared::open_dynamic_archive() {
990 if (DynamicDumpSharedSpaces) {
991 return nullptr;
992 }
993 const char* dynamic_archive = Arguments::GetSharedDynamicArchivePath();
994 if (dynamic_archive == nullptr) {
995 return nullptr;
996 }
997
998 FileMapInfo* mapinfo = new FileMapInfo(dynamic_archive, false);
999 if (!mapinfo->initialize()) {
1000 delete(mapinfo);
1001 if (RequireSharedSpaces) {
1002 MetaspaceShared::unrecoverable_loading_error("Failed to initialize dynamic archive");
1003 }
1004 return nullptr;
1005 }
1006 return mapinfo;
1007 }
1008
1009 // use_requested_addr:
1010 // true = map at FileMapHeader::_requested_base_address
1011 // false = map at an alternative address picked by OS.
1012 MapArchiveResult MetaspaceShared::map_archives(FileMapInfo* static_mapinfo, FileMapInfo* dynamic_mapinfo,
1013 bool use_requested_addr) {
1014 if (use_requested_addr && static_mapinfo->requested_base_address() == nullptr) {
1015 log_info(cds)("Archive(s) were created with -XX:SharedBaseAddress=0. Always map at os-selected address.");
1016 return MAP_ARCHIVE_MMAP_FAILURE;
1017 }
1018
1019 PRODUCT_ONLY(if (ArchiveRelocationMode == 1 && use_requested_addr) {
1020 // For product build only -- this is for benchmarking the cost of doing relocation.
1021 // For debug builds, the check is done below, after reserving the space, for better test coverage
1022 // (see comment below).
1023 log_info(cds)("ArchiveRelocationMode == 1: always map archive(s) at an alternative address");
1024 return MAP_ARCHIVE_MMAP_FAILURE;
1025 });
1026
1027 if (ArchiveRelocationMode == 2 && !use_requested_addr) {
1028 log_info(cds)("ArchiveRelocationMode == 2: never map archive(s) at an alternative address");
1029 return MAP_ARCHIVE_MMAP_FAILURE;
1030 };
1031
1032 if (dynamic_mapinfo != nullptr) {
1033 // Ensure that the OS won't be able to allocate new memory spaces between the two
1034 // archives, or else it would mess up the simple comparison in MetaspaceObj::is_shared().
1035 assert(static_mapinfo->mapping_end_offset() == dynamic_mapinfo->mapping_base_offset(), "no gap");
1036 }
1037
1038 ReservedSpace total_space_rs, archive_space_rs, class_space_rs;
1039 MapArchiveResult result = MAP_ARCHIVE_OTHER_FAILURE;
1040 char* mapped_base_address = reserve_address_space_for_archives(static_mapinfo,
1041 dynamic_mapinfo,
1042 use_requested_addr,
1043 total_space_rs,
1044 archive_space_rs,
1045 class_space_rs);
1046 if (mapped_base_address == nullptr) {
1047 result = MAP_ARCHIVE_MMAP_FAILURE;
1048 log_debug(cds)("Failed to reserve spaces (use_requested_addr=%u)", (unsigned)use_requested_addr);
1049 } else {
1050
1051 #ifdef ASSERT
1052 // Some sanity checks after reserving address spaces for archives
1053 // and class space.
1054 assert(archive_space_rs.is_reserved(), "Sanity");
1055 if (Metaspace::using_class_space()) {
1056 // Class space must closely follow the archive space. Both spaces
1057 // must be aligned correctly.
1058 assert(class_space_rs.is_reserved(),
1059 "A class space should have been reserved");
1060 assert(class_space_rs.base() >= archive_space_rs.end(),
1061 "class space should follow the cds archive space");
1062 assert(is_aligned(archive_space_rs.base(),
1063 core_region_alignment()),
1064 "Archive space misaligned");
1065 assert(is_aligned(class_space_rs.base(),
1066 Metaspace::reserve_alignment()),
1067 "class space misaligned");
1068 }
1069 #endif // ASSERT
1070
1071 log_info(cds)("Reserved archive_space_rs [" INTPTR_FORMAT " - " INTPTR_FORMAT "] (" SIZE_FORMAT ") bytes",
1072 p2i(archive_space_rs.base()), p2i(archive_space_rs.end()), archive_space_rs.size());
1073 log_info(cds)("Reserved class_space_rs [" INTPTR_FORMAT " - " INTPTR_FORMAT "] (" SIZE_FORMAT ") bytes",
1074 p2i(class_space_rs.base()), p2i(class_space_rs.end()), class_space_rs.size());
1075
1076 if (MetaspaceShared::use_windows_memory_mapping()) {
1077 // We have now reserved address space for the archives, and will map in
1078 // the archive files into this space.
1079 //
1080 // Special handling for Windows: on Windows we cannot map a file view
1081 // into an existing memory mapping. So, we unmap the address range we
1082 // just reserved again, which will make it available for mapping the
1083 // archives.
1084 // Reserving this range has not been for naught however since it makes
1085 // us reasonably sure the address range is available.
1086 //
1087 // But still it may fail, since between unmapping the range and mapping
1088 // in the archive someone else may grab the address space. Therefore
1089 // there is a fallback in FileMap::map_region() where we just read in
1090 // the archive files sequentially instead of mapping it in. We couple
1091 // this with use_requested_addr, since we're going to patch all the
1092 // pointers anyway so there's no benefit to mmap.
1093 if (use_requested_addr) {
1094 assert(!total_space_rs.is_reserved(), "Should not be reserved for Windows");
1095 log_info(cds)("Windows mmap workaround: releasing archive space.");
1096 archive_space_rs.release();
1097 }
1098 }
1099 MapArchiveResult static_result = map_archive(static_mapinfo, mapped_base_address, archive_space_rs);
1100 MapArchiveResult dynamic_result = (static_result == MAP_ARCHIVE_SUCCESS) ?
1101 map_archive(dynamic_mapinfo, mapped_base_address, archive_space_rs) : MAP_ARCHIVE_OTHER_FAILURE;
1102
1103 DEBUG_ONLY(if (ArchiveRelocationMode == 1 && use_requested_addr) {
1104 // This is for simulating mmap failures at the requested address. In
1105 // debug builds, we do it here (after all archives have possibly been
1106 // mapped), so we can thoroughly test the code for failure handling
1107 // (releasing all allocated resource, etc).
1108 log_info(cds)("ArchiveRelocationMode == 1: always map archive(s) at an alternative address");
1109 if (static_result == MAP_ARCHIVE_SUCCESS) {
1110 static_result = MAP_ARCHIVE_MMAP_FAILURE;
1111 }
1112 if (dynamic_result == MAP_ARCHIVE_SUCCESS) {
1113 dynamic_result = MAP_ARCHIVE_MMAP_FAILURE;
1114 }
1115 });
1116
1117 if (static_result == MAP_ARCHIVE_SUCCESS) {
1118 if (dynamic_result == MAP_ARCHIVE_SUCCESS) {
1119 result = MAP_ARCHIVE_SUCCESS;
1120 } else if (dynamic_result == MAP_ARCHIVE_OTHER_FAILURE) {
1121 assert(dynamic_mapinfo != nullptr && !dynamic_mapinfo->is_mapped(), "must have failed");
1122 // No need to retry mapping the dynamic archive again, as it will never succeed
1123 // (bad file, etc) -- just keep the base archive.
1124 log_warning(cds, dynamic)("Unable to use shared archive. The top archive failed to load: %s",
1125 dynamic_mapinfo->full_path());
1126 result = MAP_ARCHIVE_SUCCESS;
1127 // TODO, we can give the unused space for the dynamic archive to class_space_rs, but there's no
1128 // easy API to do that right now.
1129 } else {
1130 result = MAP_ARCHIVE_MMAP_FAILURE;
1131 }
1132 } else if (static_result == MAP_ARCHIVE_OTHER_FAILURE) {
1133 result = MAP_ARCHIVE_OTHER_FAILURE;
1134 } else {
1135 result = MAP_ARCHIVE_MMAP_FAILURE;
1136 }
1137 }
1138
1139 if (result == MAP_ARCHIVE_SUCCESS) {
1140 SharedBaseAddress = (size_t)mapped_base_address;
1141 LP64_ONLY({
1142 if (Metaspace::using_class_space()) {
1143 // Set up ccs in metaspace.
1144 Metaspace::initialize_class_space(class_space_rs);
1145
1146 // Set up compressed Klass pointer encoding: the encoding range must
1147 // cover both archive and class space.
1148 address cds_base = (address)static_mapinfo->mapped_base();
1149 address ccs_end = (address)class_space_rs.end();
1150 assert(ccs_end > cds_base, "Sanity check");
1151 CompressedKlassPointers::initialize(cds_base, ccs_end - cds_base);
1152
1153 // map_or_load_heap_region() compares the current narrow oop and klass encodings
1154 // with the archived ones, so it must be done after all encodings are determined.
1155 static_mapinfo->map_or_load_heap_region();
1156 }
1157 });
1158 log_info(cds)("optimized module handling: %s", MetaspaceShared::use_optimized_module_handling() ? "enabled" : "disabled");
1159 log_info(cds)("full module graph: %s", MetaspaceShared::use_full_module_graph() ? "enabled" : "disabled");
1160 } else {
1161 unmap_archive(static_mapinfo);
1162 unmap_archive(dynamic_mapinfo);
1163 release_reserved_spaces(total_space_rs, archive_space_rs, class_space_rs);
1164 }
1165
1166 return result;
1167 }
1168
1169
1170 // This will reserve two address spaces suitable to house Klass structures, one
1171 // for the cds archives (static archive and optionally dynamic archive) and
1172 // optionally one move for ccs.
1173 //
1174 // Since both spaces must fall within the compressed class pointer encoding
1175 // range, they are allocated close to each other.
1176 //
1177 // Space for archives will be reserved first, followed by a potential gap,
1178 // followed by the space for ccs:
1179 //
1180 // +-- Base address A B End
1181 // | | | |
1182 // v v v v
1183 // +-------------+--------------+ +----------------------+
1184 // | static arc | [dyn. arch] | [gap] | compr. class space |
1185 // +-------------+--------------+ +----------------------+
1186 //
1187 // (The gap may result from different alignment requirements between metaspace
1188 // and CDS)
1189 //
1190 // If UseCompressedClassPointers is disabled, only one address space will be
1191 // reserved:
1192 //
1193 // +-- Base address End
1194 // | |
1195 // v v
1196 // +-------------+--------------+
1197 // | static arc | [dyn. arch] |
1198 // +-------------+--------------+
1199 //
1200 // Base address: If use_archive_base_addr address is true, the Base address is
1201 // determined by the address stored in the static archive. If
1202 // use_archive_base_addr address is false, this base address is determined
1203 // by the platform.
1204 //
1205 // If UseCompressedClassPointers=1, the range encompassing both spaces will be
1206 // suitable to en/decode narrow Klass pointers: the base will be valid for
1207 // encoding, the range [Base, End) not surpass KlassEncodingMetaspaceMax.
1208 //
1209 // Return:
1210 //
1211 // - On success:
1212 // - total_space_rs will be reserved as whole for archive_space_rs and
1213 // class_space_rs if UseCompressedClassPointers is true.
1214 // On Windows, try reserve archive_space_rs and class_space_rs
1215 // separately first if use_archive_base_addr is true.
1216 // - archive_space_rs will be reserved and large enough to host static and
1217 // if needed dynamic archive: [Base, A).
1218 // archive_space_rs.base and size will be aligned to CDS reserve
1219 // granularity.
1220 // - class_space_rs: If UseCompressedClassPointers=1, class_space_rs will
1221 // be reserved. Its start address will be aligned to metaspace reserve
1222 // alignment, which may differ from CDS alignment. It will follow the cds
1223 // archive space, close enough such that narrow class pointer encoding
1224 // covers both spaces.
1225 // If UseCompressedClassPointers=0, class_space_rs remains unreserved.
1226 // - On error: null is returned and the spaces remain unreserved.
1227 char* MetaspaceShared::reserve_address_space_for_archives(FileMapInfo* static_mapinfo,
1228 FileMapInfo* dynamic_mapinfo,
1229 bool use_archive_base_addr,
1230 ReservedSpace& total_space_rs,
1231 ReservedSpace& archive_space_rs,
1232 ReservedSpace& class_space_rs) {
1233
1234 address const base_address = (address) (use_archive_base_addr ? static_mapinfo->requested_base_address() : nullptr);
1235 const size_t archive_space_alignment = core_region_alignment();
1236
1237 // Size and requested location of the archive_space_rs (for both static and dynamic archives)
1238 assert(static_mapinfo->mapping_base_offset() == 0, "Must be");
1239 size_t archive_end_offset = (dynamic_mapinfo == nullptr) ? static_mapinfo->mapping_end_offset() : dynamic_mapinfo->mapping_end_offset();
1240 size_t archive_space_size = align_up(archive_end_offset, archive_space_alignment);
1241
1242 // If a base address is given, it must have valid alignment and be suitable as encoding base.
1243 if (base_address != nullptr) {
1244 assert(is_aligned(base_address, archive_space_alignment),
1245 "Archive base address invalid: " PTR_FORMAT ".", p2i(base_address));
1246 if (Metaspace::using_class_space()) {
1247 assert(CompressedKlassPointers::is_valid_base(base_address),
1248 "Archive base address invalid: " PTR_FORMAT ".", p2i(base_address));
1249 }
1250 }
1251
1252 if (!Metaspace::using_class_space()) {
1253 // Get the simple case out of the way first:
1254 // no compressed class space, simple allocation.
1255 archive_space_rs = ReservedSpace(archive_space_size, archive_space_alignment,
1256 os::vm_page_size(), (char*)base_address);
1257 if (archive_space_rs.is_reserved()) {
1258 assert(base_address == nullptr ||
1259 (address)archive_space_rs.base() == base_address, "Sanity");
1260 // Register archive space with NMT.
1261 MemTracker::record_virtual_memory_type(archive_space_rs.base(), mtClassShared);
1262 return archive_space_rs.base();
1263 }
1264 return nullptr;
1265 }
1266
1267 #ifdef _LP64
1268
1269 // Complex case: two spaces adjacent to each other, both to be addressable
1270 // with narrow class pointers.
1271 // We reserve the whole range spanning both spaces, then split that range up.
1272
1273 const size_t class_space_alignment = Metaspace::reserve_alignment();
1274
1275 // To simplify matters, lets assume that metaspace alignment will always be
1276 // equal or a multiple of archive alignment.
1277 assert(is_power_of_2(class_space_alignment) &&
1278 is_power_of_2(archive_space_alignment) &&
1279 class_space_alignment >= archive_space_alignment,
1280 "Sanity");
1281
1282 const size_t class_space_size = CompressedClassSpaceSize;
1283 assert(CompressedClassSpaceSize > 0 &&
1284 is_aligned(CompressedClassSpaceSize, class_space_alignment),
1285 "CompressedClassSpaceSize malformed: "
1286 SIZE_FORMAT, CompressedClassSpaceSize);
1287
1288 const size_t ccs_begin_offset = align_up(base_address + archive_space_size,
1289 class_space_alignment) - base_address;
1290 const size_t gap_size = ccs_begin_offset - archive_space_size;
1291
1292 const size_t total_range_size =
1293 align_up(archive_space_size + gap_size + class_space_size, core_region_alignment());
1294
1295 assert(total_range_size > ccs_begin_offset, "must be");
1296 if (use_windows_memory_mapping() && use_archive_base_addr) {
1297 if (base_address != nullptr) {
1298 // On Windows, we cannot safely split a reserved memory space into two (see JDK-8255917).
1299 // Hence, we optimistically reserve archive space and class space side-by-side. We only
1300 // do this for use_archive_base_addr=true since for use_archive_base_addr=false case
1301 // caller will not split the combined space for mapping, instead read the archive data
1302 // via sequential file IO.
1303 address ccs_base = base_address + archive_space_size + gap_size;
1304 archive_space_rs = ReservedSpace(archive_space_size, archive_space_alignment,
1305 os::vm_page_size(), (char*)base_address);
1306 class_space_rs = ReservedSpace(class_space_size, class_space_alignment,
1307 os::vm_page_size(), (char*)ccs_base);
1308 }
1309 if (!archive_space_rs.is_reserved() || !class_space_rs.is_reserved()) {
1310 release_reserved_spaces(total_space_rs, archive_space_rs, class_space_rs);
1311 return nullptr;
1312 }
1313 } else {
1314 if (use_archive_base_addr && base_address != nullptr) {
1315 total_space_rs = ReservedSpace(total_range_size, archive_space_alignment,
1316 os::vm_page_size(), (char*) base_address);
1317 } else {
1318 // Reserve at any address, but leave it up to the platform to choose a good one.
1319 total_space_rs = Metaspace::reserve_address_space_for_compressed_classes(total_range_size);
1320 }
1321
1322 if (!total_space_rs.is_reserved()) {
1323 return nullptr;
1324 }
1325
1326 // Paranoid checks:
1327 assert(base_address == nullptr || (address)total_space_rs.base() == base_address,
1328 "Sanity (" PTR_FORMAT " vs " PTR_FORMAT ")", p2i(base_address), p2i(total_space_rs.base()));
1329 assert(is_aligned(total_space_rs.base(), archive_space_alignment), "Sanity");
1330 assert(total_space_rs.size() == total_range_size, "Sanity");
1331 assert(CompressedKlassPointers::is_valid_base((address)total_space_rs.base()), "Sanity");
1332
1333 // Now split up the space into ccs and cds archive. For simplicity, just leave
1334 // the gap reserved at the end of the archive space. Do not do real splitting.
1335 archive_space_rs = total_space_rs.first_part(ccs_begin_offset,
1336 (size_t)archive_space_alignment);
1337 class_space_rs = total_space_rs.last_part(ccs_begin_offset);
1338 MemTracker::record_virtual_memory_split_reserved(total_space_rs.base(), total_space_rs.size(),
1339 ccs_begin_offset);
1340 }
1341 assert(is_aligned(archive_space_rs.base(), archive_space_alignment), "Sanity");
1342 assert(is_aligned(archive_space_rs.size(), archive_space_alignment), "Sanity");
1343 assert(is_aligned(class_space_rs.base(), class_space_alignment), "Sanity");
1344 assert(is_aligned(class_space_rs.size(), class_space_alignment), "Sanity");
1345
1346 // NMT: fix up the space tags
1347 MemTracker::record_virtual_memory_type(archive_space_rs.base(), mtClassShared);
1348 MemTracker::record_virtual_memory_type(class_space_rs.base(), mtClass);
1349
1350 return archive_space_rs.base();
1351
1352 #else
1353 ShouldNotReachHere();
1354 return nullptr;
1355 #endif
1356
1357 }
1358
1359 void MetaspaceShared::release_reserved_spaces(ReservedSpace& total_space_rs,
1360 ReservedSpace& archive_space_rs,
1361 ReservedSpace& class_space_rs) {
1362 if (total_space_rs.is_reserved()) {
1363 log_debug(cds)("Released shared space (archive + class) " INTPTR_FORMAT, p2i(total_space_rs.base()));
1364 total_space_rs.release();
1365 } else {
1366 if (archive_space_rs.is_reserved()) {
1367 log_debug(cds)("Released shared space (archive) " INTPTR_FORMAT, p2i(archive_space_rs.base()));
1368 archive_space_rs.release();
1369 }
1370 if (class_space_rs.is_reserved()) {
1371 log_debug(cds)("Released shared space (classes) " INTPTR_FORMAT, p2i(class_space_rs.base()));
1372 class_space_rs.release();
1373 }
1374 }
1375 }
1376
1377 static int archive_regions[] = { MetaspaceShared::rw, MetaspaceShared::ro };
1378 static int archive_regions_count = 2;
1379
1380 MapArchiveResult MetaspaceShared::map_archive(FileMapInfo* mapinfo, char* mapped_base_address, ReservedSpace rs) {
1381 assert(UseSharedSpaces, "must be runtime");
1382 if (mapinfo == nullptr) {
1383 return MAP_ARCHIVE_SUCCESS; // The dynamic archive has not been specified. No error has happened -- trivially succeeded.
1384 }
1385
1386 mapinfo->set_is_mapped(false);
1387 if (mapinfo->core_region_alignment() != (size_t)core_region_alignment()) {
1388 log_info(cds)("Unable to map CDS archive -- core_region_alignment() expected: " SIZE_FORMAT
1389 " actual: " SIZE_FORMAT, mapinfo->core_region_alignment(), core_region_alignment());
1390 return MAP_ARCHIVE_OTHER_FAILURE;
1391 }
1392
1393 MapArchiveResult result =
1394 mapinfo->map_regions(archive_regions, archive_regions_count, mapped_base_address, rs);
1395
1396 if (result != MAP_ARCHIVE_SUCCESS) {
1397 unmap_archive(mapinfo);
1398 return result;
1399 }
1400
1401 if (!mapinfo->validate_shared_path_table()) {
1402 unmap_archive(mapinfo);
1403 return MAP_ARCHIVE_OTHER_FAILURE;
1404 }
1405
1406 mapinfo->set_is_mapped(true);
1407 return MAP_ARCHIVE_SUCCESS;
1408 }
1409
1410 void MetaspaceShared::unmap_archive(FileMapInfo* mapinfo) {
1411 assert(UseSharedSpaces, "must be runtime");
1412 if (mapinfo != nullptr) {
1413 mapinfo->unmap_regions(archive_regions, archive_regions_count);
1414 mapinfo->unmap_region(MetaspaceShared::bm);
1415 mapinfo->set_is_mapped(false);
1416 }
1417 }
1418
1419 // For -XX:PrintSharedArchiveAndExit
1420 class CountSharedSymbols : public SymbolClosure {
1421 private:
1422 int _count;
1423 public:
1424 CountSharedSymbols() : _count(0) {}
1425 void do_symbol(Symbol** sym) {
1426 _count++;
1427 }
1428 int total() { return _count; }
1429
1430 };
1431
1432 // Read the miscellaneous data from the shared file, and
1433 // serialize it out to its various destinations.
1434
1435 void MetaspaceShared::initialize_shared_spaces() {
1436 FileMapInfo *static_mapinfo = FileMapInfo::current_info();
1437
1438 // Verify various attributes of the archive, plus initialize the
1439 // shared string/symbol tables.
1440 char* buffer = static_mapinfo->serialized_data();
1441 intptr_t* array = (intptr_t*)buffer;
1442 ReadClosure rc(&array);
1443 serialize(&rc);
1444
1445 // Finish up archived heap initialization. These must be
1446 // done after ReadClosure.
1447 static_mapinfo->patch_heap_embedded_pointers();
1448 ArchiveHeapLoader::finish_initialization();
1449
1450 CDS_JAVA_HEAP_ONLY(Universe::update_archived_basic_type_mirrors());
1451
1452 // Close the mapinfo file
1453 static_mapinfo->close();
1454
1455 static_mapinfo->unmap_region(MetaspaceShared::bm);
1456
1457 FileMapInfo *dynamic_mapinfo = FileMapInfo::dynamic_info();
1458 if (dynamic_mapinfo != nullptr) {
1459 intptr_t* buffer = (intptr_t*)dynamic_mapinfo->serialized_data();
1460 ReadClosure rc(&buffer);
1461 SymbolTable::serialize_shared_table_header(&rc, false);
1462 SystemDictionaryShared::serialize_dictionary_headers(&rc, false);
1463 dynamic_mapinfo->close();
1464 dynamic_mapinfo->unmap_region(MetaspaceShared::bm);
1465 }
1466
1467 // Set up LambdaFormInvokers::_lambdaform_lines for dynamic dump
1468 if (DynamicDumpSharedSpaces) {
1469 // Read stored LF format lines stored in static archive
1470 LambdaFormInvokers::read_static_archive_invokers();
1471 }
1472
1473 if (PrintSharedArchiveAndExit) {
1474 // Print archive names
1475 if (dynamic_mapinfo != nullptr) {
1476 tty->print_cr("\n\nBase archive name: %s", Arguments::GetSharedArchivePath());
1477 tty->print_cr("Base archive version %d", static_mapinfo->version());
1478 } else {
1479 tty->print_cr("Static archive name: %s", static_mapinfo->full_path());
1480 tty->print_cr("Static archive version %d", static_mapinfo->version());
1481 }
1482
1483 SystemDictionaryShared::print_shared_archive(tty);
1484 if (dynamic_mapinfo != nullptr) {
1485 tty->print_cr("\n\nDynamic archive name: %s", dynamic_mapinfo->full_path());
1486 tty->print_cr("Dynamic archive version %d", dynamic_mapinfo->version());
1487 SystemDictionaryShared::print_shared_archive(tty, false/*dynamic*/);
1488 }
1489
1490 // collect shared symbols and strings
1491 CountSharedSymbols cl;
1492 SymbolTable::shared_symbols_do(&cl);
1493 tty->print_cr("Number of shared symbols: %d", cl.total());
1494 tty->print_cr("Number of shared strings: %zu", StringTable::shared_entry_count());
1495 tty->print_cr("VM version: %s\r\n", static_mapinfo->vm_version());
1496 if (FileMapInfo::current_info() == nullptr || _archive_loading_failed) {
1497 tty->print_cr("archive is invalid");
1498 vm_exit(1);
1499 } else {
1500 tty->print_cr("archive is valid");
1501 vm_exit(0);
1502 }
1503 }
1504 }
1505
1506 // JVM/TI RedefineClasses() support:
1507 bool MetaspaceShared::remap_shared_readonly_as_readwrite() {
1508 assert(SafepointSynchronize::is_at_safepoint(), "must be at safepoint");
1509
1510 if (UseSharedSpaces) {
1511 // remap the shared readonly space to shared readwrite, private
1512 FileMapInfo* mapinfo = FileMapInfo::current_info();
1513 if (!mapinfo->remap_shared_readonly_as_readwrite()) {
1514 return false;
1515 }
1516 if (FileMapInfo::dynamic_info() != nullptr) {
1517 mapinfo = FileMapInfo::dynamic_info();
1518 if (!mapinfo->remap_shared_readonly_as_readwrite()) {
1519 return false;
1520 }
1521 }
1522 _remapped_readwrite = true;
1523 }
1524 return true;
1525 }
1526
1527 bool MetaspaceShared::use_full_module_graph() {
1528 #if INCLUDE_CDS_JAVA_HEAP
1529 if (ClassLoaderDataShared::is_full_module_graph_loaded()) {
1530 return true;
1531 }
1532 #endif
1533 bool result = _use_optimized_module_handling && _use_full_module_graph;
1534 if (DumpSharedSpaces) {
1535 result &= HeapShared::can_write();
1536 } else if (UseSharedSpaces) {
1537 result &= ArchiveHeapLoader::can_use();
1538 } else {
1539 result = false;
1540 }
1541
1542 if (result && UseSharedSpaces) {
1543 // Classes used by the archived full module graph are loaded in JVMTI early phase.
1544 assert(!(JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()),
1545 "CDS should be disabled if early class hooks are enabled");
1546 }
1547 return result;
1548 }
1549
1550 void MetaspaceShared::print_on(outputStream* st) {
1551 if (UseSharedSpaces) {
1552 st->print("CDS archive(s) mapped at: ");
1553 address base = (address)MetaspaceObj::shared_metaspace_base();
1554 address static_top = (address)_shared_metaspace_static_top;
1555 address top = (address)MetaspaceObj::shared_metaspace_top();
1556 st->print("[" PTR_FORMAT "-" PTR_FORMAT "-" PTR_FORMAT "), ", p2i(base), p2i(static_top), p2i(top));
1557 st->print("size " SIZE_FORMAT ", ", top - base);
1558 st->print("SharedBaseAddress: " PTR_FORMAT ", ArchiveRelocationMode: %d.", SharedBaseAddress, ArchiveRelocationMode);
1559 } else {
1560 st->print("CDS archive(s) not mapped");
1561 }
1562 st->cr();
1563 }