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