1 /*
2 * Copyright (c) 2003, 2026, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_CDS_FILEMAP_HPP
26 #define SHARE_CDS_FILEMAP_HPP
27
28 #include "cds/aotCompressedPointers.hpp"
29 #include "cds/aotMappedHeap.hpp"
30 #include "cds/aotMetaspace.hpp"
31 #include "cds/aotStreamedHeap.hpp"
32 #include "cds/archiveUtils.hpp"
33 #include "cds/heapShared.hpp"
34 #include "include/cds.h"
35 #include "logging/logLevel.hpp"
36 #include "memory/allocation.hpp"
37 #include "oops/array.hpp"
38 #include "oops/compressedOops.hpp"
39 #include "runtime/globals.hpp"
40 #include "utilities/align.hpp"
41 #include "utilities/bitMap.hpp"
42
43 // To understand the layout of the CDS archive file:
44 //
45 // java -Xlog:cds+map=info:file=cds.map:none:filesize=0
46 // java -Xlog:cds+map=debug:file=cds.map:none:filesize=0
47 // java -Xlog:cds+map=trace:file=cds.map:none:filesize=0
48
49 static const int JVM_IDENT_MAX = 256;
50
51 class AOTClassLocationConfig;
52 class BitMapView;
53 class CHeapBitMap;
54 class ClassFileStream;
55 class ClassLoaderData;
56 class ClassPathEntry;
57 class outputStream;
58 class ReservedSpace;
59
60 class FileMapRegion: private CDSFileMapRegion {
61 public:
62 void assert_is_heap_region() const {
63 assert(_is_heap_region, "must be heap region");
64 }
65 void assert_is_not_heap_region() const {
66 assert(!_is_heap_region, "must not be heap region");
67 }
68
69 static FileMapRegion* cast(CDSFileMapRegion* p) {
70 return (FileMapRegion*)p;
71 }
72
73 // Accessors
74 int crc() const { return _crc; }
75 size_t file_offset() const { return _file_offset; }
76 size_t mapping_offset() const { return _mapping_offset; }
77 size_t mapping_end_offset() const { return _mapping_offset + used_aligned(); }
78 size_t used() const { return _used; }
79 size_t used_aligned() const; // aligned up to AOTMetaspace::core_region_alignment()
80 char* mapped_base() const { return _mapped_base; }
81 char* mapped_end() const { return mapped_base() + used_aligned(); }
82 bool read_only() const { return _read_only != 0; }
83 bool allow_exec() const { return _allow_exec != 0; }
84 bool mapped_from_file() const { return _mapped_from_file != 0; }
85 size_t oopmap_offset() const { assert_is_heap_region(); return _oopmap_offset; }
86 size_t oopmap_size_in_bits() const { assert_is_heap_region(); return _oopmap_size_in_bits; }
87 size_t ptrmap_offset() const { return _ptrmap_offset; }
88 size_t ptrmap_size_in_bits() const { return _ptrmap_size_in_bits; }
89 bool in_reserved_space() const { return _in_reserved_space; }
90
91 void set_file_offset(size_t s) { _file_offset = s; }
92 void set_read_only(bool v) { _read_only = v; }
93 void set_mapped_base(char* p) { _mapped_base = p; }
94 void set_mapped_from_file(bool v) { _mapped_from_file = v; }
95 void set_in_reserved_space(bool is_reserved) { _in_reserved_space = is_reserved; }
96 void init(int region_index, size_t mapping_offset, size_t size, bool read_only,
97 bool allow_exec, int crc);
98 void init_oopmap(size_t offset, size_t size_in_bits);
99 void init_ptrmap(size_t offset, size_t size_in_bits);
100 bool has_ptrmap() { return _ptrmap_size_in_bits != 0; }
101
102 bool check_region_crc(char* base) const;
103 void print(outputStream* st, int region_index);
104 };
105
106 #define CDS_MUST_MATCH_FLAGS_DO(f) \
107 f(UseArrayFlattening) \
108 f(UseFieldFlattening) \
109 f(InlineTypePassFieldsAsArgs) \
110 f(InlineTypeReturnedAsFields) \
111 f(UseNonAtomicValueFlattening) \
112 f(UseAtomicValueFlattening) \
113 f(UseNullableValueFlattening) \
114 f(UseNullableNonAtomicValueFlattening)
115
116
117 class CDSMustMatchFlags {
118 private:
119 size_t _max_name_width;
120 #define DECLARE_CDS_MUST_MATCH_FLAG(n) \
121 decltype(n) _v_##n;
122 CDS_MUST_MATCH_FLAGS_DO(DECLARE_CDS_MUST_MATCH_FLAG);
123 #undef DECLARE_CDS_MUST_MATCH_FLAG
124
125 inline static void do_print(outputStream* st, bool v);
126 inline static void do_print(outputStream* st, intx v);
127 inline static void do_print(outputStream* st, uintx v);
128 inline static void do_print(outputStream* st, double v);
129 void print_info() const;
130
131 public:
132 void init();
133 bool runtime_check() const;
134 void print(outputStream* st) const;
135 };
136
137 class FileMapHeader: private CDSFileMapHeaderBase {
138 friend class CDSConstants;
139 friend class VMStructs;
140 using narrowPtr = AOTCompressedPointers::narrowPtr;
141 private:
142 // The following fields record the states of the VM during dump time.
143 // They are compared with the runtime states to see if the archive
144 // can be used.
145 size_t _core_region_alignment; // how shared archive should be aligned
146 int _obj_alignment; // value of ObjectAlignmentInBytes
147 address _narrow_oop_base; // compressed oop encoding base
148 int _narrow_oop_shift; // compressed oop encoding shift
149 bool _compact_strings; // value of CompactStrings
150 bool _compact_headers; // value of UseCompactObjectHeaders
151 uintx _max_heap_size; // java max heap size during dumping
152 CompressedOops::Mode _narrow_oop_mode; // compressed oop encoding mode
153 bool _object_streaming_mode; // dump was created for object streaming
154 bool _compressed_oops; // save the flag UseCompressedOops
155 bool _compressed_class_ptrs; // save the flag UseCompressedClassPointers
156 int _narrow_klass_pointer_bits; // save number of bits in narrowKlass
157 int _narrow_klass_shift; // save shift width used to pre-compute narrowKlass IDs in archived heap objects
158 narrowPtr _cloned_vtables; // The address of the first cloned vtable
159 narrowPtr _early_serialized_data; // Data accessed using {ReadClosure,WriteClosure}::serialize()
160 narrowPtr _serialized_data; // Data accessed using {ReadClosure,WriteClosure}::serialize()
161
162 // The following fields are all sanity checks for whether this archive
163 // will function correctly with this JVM and the bootclasspath it's
164 // invoked with.
165 char _jvm_ident[JVM_IDENT_MAX]; // identifier string of the jvm that created this dump
166
167 narrowPtr _class_location_config;
168
169 bool _verify_local; // BytecodeVerificationLocal setting
170 bool _verify_remote; // BytecodeVerificationRemote setting
171 bool _has_platform_or_app_classes; // Archive contains app or platform classes
172 char* _requested_base_address; // Archive relocation is not necessary if we map with this base address.
173 char* _mapped_base_address; // Actual base address where archive is mapped.
174
175 bool _use_optimized_module_handling;// No module-relation VM options were specified, so we can skip
176 // some expensive operations.
177 bool _has_aot_linked_classes; // Was the CDS archive created with -XX:+AOTClassLinking
178 bool _has_full_module_graph; // Does this CDS archive contain the full archived module graph?
179 bool _has_valhalla_patched_classes; // Is this archived dumped with --enable-preview?
180 CDSMustMatchFlags _must_match; // These flags must be the same between dumptime and runtime
181 size_t _rw_ptrmap_start_pos; // The first bit in the ptrmap corresponds to this position in the rw region
182 size_t _ro_ptrmap_start_pos; // The first bit in the ptrmap corresponds to this position in the ro region
183
184 AOTMappedHeapHeader _mapped_heap_header;
185 AOTStreamedHeapHeader _streamed_heap_header;
186
187 // The following are parameters that affect MethodData layout.
188 u1 _compiler_type;
189 uint _type_profile_level;
190 int _type_profile_args_limit;
191 int _type_profile_parms_limit;
192 intx _type_profile_width;
193 intx _bci_profile_width;
194 bool _profile_traps;
195 bool _type_profile_casts;
196 int _spec_trap_limit_extra_entries;
197
198 template <typename T> T decode(narrowPtr narrowp) const {
199 return AOTCompressedPointers::decode_not_null<T>(narrowp, reinterpret_cast<address>(mapped_base_address()));
200 }
201
202 public:
203 // Accessors -- fields declared in GenericCDSFileMapHeader
204 unsigned int magic() const { return _generic_header._magic; }
205 int crc() const { return _generic_header._crc; }
206 int version() const { return _generic_header._version; }
207 unsigned int header_size() const { return _generic_header._header_size; }
208 unsigned int base_archive_name_offset() const { return _generic_header._base_archive_name_offset; }
209 unsigned int base_archive_name_size() const { return _generic_header._base_archive_name_size; }
210
211 void set_magic(unsigned int m) { _generic_header._magic = m; }
212 void set_crc(int crc_value) { _generic_header._crc = crc_value; }
213 void set_version(int v) { _generic_header._version = v; }
214 void set_header_size(unsigned int s) { _generic_header._header_size = s; }
215 void set_base_archive_name_offset(unsigned int s) { _generic_header._base_archive_name_offset = s; }
216 void set_base_archive_name_size(unsigned int s) { _generic_header._base_archive_name_size = s; }
217
218 bool is_static() const { return magic() == CDS_ARCHIVE_MAGIC; }
219 size_t core_region_alignment() const { return _core_region_alignment; }
220 int obj_alignment() const { return _obj_alignment; }
221 address narrow_oop_base() const { return _narrow_oop_base; }
222 int narrow_oop_shift() const { return _narrow_oop_shift; }
223 bool compact_strings() const { return _compact_strings; }
224 bool compact_headers() const { return _compact_headers; }
225 uintx max_heap_size() const { return _max_heap_size; }
226 CompressedOops::Mode narrow_oop_mode() const { return _narrow_oop_mode; }
227 char* cloned_vtables() const { return decode<char*>(_cloned_vtables); }
228 char* early_serialized_data() const { return decode<char*>(_early_serialized_data); }
229 char* serialized_data() const { return decode<char*>(_serialized_data); }
230 bool object_streaming_mode() const { return _object_streaming_mode; }
231 const char* jvm_ident() const { return _jvm_ident; }
232 char* requested_base_address() const { return _requested_base_address; }
233 char* mapped_base_address() const { return _mapped_base_address; }
234 bool has_platform_or_app_classes() const { return _has_platform_or_app_classes; }
235 bool has_aot_linked_classes() const { return _has_aot_linked_classes; }
236 bool compressed_oops() const { return _compressed_oops; }
237 bool compressed_class_pointers() const { return _compressed_class_ptrs; }
238 int narrow_klass_pointer_bits() const { return _narrow_klass_pointer_bits; }
239 int narrow_klass_shift() const { return _narrow_klass_shift; }
240 bool has_full_module_graph() const { return _has_full_module_graph; }
241 size_t rw_ptrmap_start_pos() const { return _rw_ptrmap_start_pos; }
242 size_t ro_ptrmap_start_pos() const { return _ro_ptrmap_start_pos; }
243
244 // Heap archiving
245 const AOTMappedHeapHeader* mapped_heap() const { return &_mapped_heap_header; }
246 const AOTStreamedHeapHeader* streamed_heap() const { return &_streamed_heap_header; }
247
248 void set_streamed_heap_header(AOTStreamedHeapHeader header) { _streamed_heap_header = header; }
249 void set_mapped_heap_header(AOTMappedHeapHeader header) { _mapped_heap_header = header; }
250
251 void set_has_platform_or_app_classes(bool v) { _has_platform_or_app_classes = v; }
252 void set_cloned_vtables(char* p) { _cloned_vtables = AOTCompressedPointers::encode_not_null(p); }
253 void set_early_serialized_data(char* p) { _early_serialized_data = AOTCompressedPointers::encode_not_null(p); }
254 void set_serialized_data(char* p) { _serialized_data = AOTCompressedPointers::encode_not_null(p); }
255 void set_mapped_base_address(char* p) { _mapped_base_address = p; }
256 void set_rw_ptrmap_start_pos(size_t n) { _rw_ptrmap_start_pos = n; }
257 void set_ro_ptrmap_start_pos(size_t n) { _ro_ptrmap_start_pos = n; }
258
259 void copy_base_archive_name(const char* name);
260
261 void set_class_location_config(AOTClassLocationConfig* table) {
262 _class_location_config = AOTCompressedPointers::encode_not_null(table);
263 }
264
265 AOTClassLocationConfig* class_location_config() {
266 return decode<AOTClassLocationConfig*>(_class_location_config);
267 }
268
269 void set_requested_base(char* b) {
270 _requested_base_address = b;
271 _mapped_base_address = nullptr;
272 }
273
274 bool validate();
275 int compute_crc();
276
277 FileMapRegion* region_at(int i) {
278 assert(is_valid_region(i), "invalid region");
279 return FileMapRegion::cast(&_regions[i]);
280 }
281
282 void populate(FileMapInfo *info, size_t core_region_alignment, size_t header_size,
283 size_t base_archive_name_size, size_t base_archive_name_offset);
284 static bool is_valid_region(int region) {
285 return (0 <= region && region < NUM_CDS_REGIONS);
286 }
287
288 bool check_must_match_flags() const {
289 return _must_match.runtime_check();
290 }
291
292 void print(outputStream* st);
293 };
294
295 class FileMapInfo : public CHeapObj<mtInternal> {
296 private:
297 friend class ManifestStream;
298 friend class VMStructs;
299 friend class ArchiveBuilder;
300 friend class CDSOffsets;
301 friend class FileMapHeader;
302
303 bool _is_static;
304 bool _file_open;
305 bool _is_mapped;
306 int _fd;
307 size_t _file_offset;
308 const char* _full_path;
309 const char* _base_archive_name;
310 FileMapHeader* _header;
311
312 // FileMapHeader describes the shared space data in the file to be
313 // mapped. This structure gets written to a file. It is not a class, so
314 // that the compilers don't add any compiler-private data to it.
315
316 static FileMapInfo* _current_info;
317 static FileMapInfo* _dynamic_archive_info;
318 static bool _memory_mapping_failed;
319
320 public:
321 FileMapHeader *header() const { return _header; }
322 static bool get_base_archive_name_from_header(const char* archive_name,
323 const char** base_archive_name);
324 static bool is_preimage_static_archive(const char* file);
325
326 bool init_from_file(int fd);
327
328 void log_paths(const char* msg, int start_idx, int end_idx);
329
330 FileMapInfo(const char* full_path, bool is_static);
331 ~FileMapInfo();
332 static void free_current_info();
333
334 // Accessors
335 int compute_header_crc() const { return header()->compute_crc(); }
336 void set_header_crc(int crc) { header()->set_crc(crc); }
337 int region_crc(int i) const { return region_at(i)->crc(); }
338 void populate_header(size_t core_region_alignment);
339 bool validate_header();
340 void invalidate();
341 int crc() const { return header()->crc(); }
342 int version() const { return header()->version(); }
343 unsigned int magic() const { return header()->magic(); }
344 address narrow_oop_base() const { return header()->narrow_oop_base(); }
345 int narrow_oop_shift() const { return header()->narrow_oop_shift(); }
346 uintx max_heap_size() const { return header()->max_heap_size(); }
347 size_t core_region_alignment() const { return header()->core_region_alignment(); }
348
349 const AOTMappedHeapHeader* mapped_heap() const { return header()->mapped_heap(); }
350 const AOTStreamedHeapHeader* streamed_heap() const { return header()->streamed_heap(); }
351
352 bool object_streaming_mode() const { return header()->object_streaming_mode(); }
353 CompressedOops::Mode narrow_oop_mode() const { return header()->narrow_oop_mode(); }
354
355 char* cloned_vtables() const { return header()->cloned_vtables(); }
356 void set_cloned_vtables(char* p) const { header()->set_cloned_vtables(p); }
357 char* early_serialized_data() const { return header()->early_serialized_data(); }
358 void set_early_serialized_data(char* p) const { header()->set_early_serialized_data(p); }
359 char* serialized_data() const { return header()->serialized_data(); }
360 void set_serialized_data(char* p) const { header()->set_serialized_data(p); }
361
362 bool is_file_position_aligned() const;
363 void align_file_position();
364
365 bool is_static() const { return _is_static; }
366 bool is_mapped() const { return _is_mapped; }
367 void set_is_mapped(bool v) { _is_mapped = v; }
368 const char* full_path() const { return _full_path; }
369 char* map_heap_region(FileMapRegion* r, char* addr, size_t bytes);
370
371 void set_requested_base(char* b) { header()->set_requested_base(b); }
372 char* requested_base_address() const { return header()->requested_base_address(); }
373
374 class DynamicArchiveHeader* dynamic_header() const {
375 assert(!is_static(), "must be");
376 return (DynamicArchiveHeader*)header();
377 }
378
379 void set_has_platform_or_app_classes(bool v) {
380 header()->set_has_platform_or_app_classes(v);
381 }
382 bool has_platform_or_app_classes() const {
383 return header()->has_platform_or_app_classes();
384 }
385
386 static FileMapInfo* current_info() {
387 CDS_ONLY(return _current_info;)
388 NOT_CDS(return nullptr;)
389 }
390
391 static void set_current_info(FileMapInfo* info) {
392 CDS_ONLY(_current_info = info;)
393 }
394
395 static FileMapInfo* dynamic_info() {
396 CDS_ONLY(return _dynamic_archive_info;)
397 NOT_CDS(return nullptr;)
398 }
399
400 static void assert_mark(bool check);
401
402 // File manipulation.
403 bool open_as_input() NOT_CDS_RETURN_(false);
404 void open_as_output();
405 void prepare_for_writing();
406 void write_header();
407 void write_region(int region, char* base, size_t size,
408 bool read_only, bool allow_exec);
409 size_t remove_bitmap_zeros(CHeapBitMap* map);
410 char* write_bitmap_region(CHeapBitMap* rw_ptrmap,
411 CHeapBitMap* ro_ptrmap,
412 AOTMappedHeapInfo* mapped_heap_info,
413 AOTStreamedHeapInfo* streamed_heap_info,
414 size_t &size_in_bytes);
415 size_t write_mapped_heap_region(AOTMappedHeapInfo* heap_info) NOT_CDS_JAVA_HEAP_RETURN_(0);
416 size_t write_streamed_heap_region(AOTStreamedHeapInfo* heap_info) NOT_CDS_JAVA_HEAP_RETURN_(0);
417 void write_bytes(const void* buffer, size_t count);
418 void write_bytes_aligned(const void* buffer, size_t count);
419 size_t read_bytes(void* buffer, size_t count);
420 static size_t readonly_total();
421 MapArchiveResult map_regions(int regions[], int num_regions, char* mapped_base_address, ReservedSpace rs);
422 void unmap_regions(int regions[], int num_regions);
423
424 // Object loading support
425 void stream_heap_region() NOT_CDS_JAVA_HEAP_RETURN;
426 void map_or_load_heap_region() NOT_CDS_JAVA_HEAP_RETURN;
427
428 bool has_heap_region() NOT_CDS_JAVA_HEAP_RETURN_(false);
429 bool read_region(int i, char* base, size_t size, bool do_commit);
430 char* map_bitmap_region();
431 bool map_aot_code_region(ReservedSpace rs);
432 char* map_forwarding_region();
433 void unmap_region(int i);
434 void close();
435 bool is_open() { return _file_open; }
436
437 // JVM/TI RedefineClasses() support:
438 // Remap the shared readonly space to shared readwrite, private.
439 bool remap_shared_readonly_as_readwrite();
440
441 static bool memory_mapping_failed() {
442 CDS_ONLY(return _memory_mapping_failed;)
443 NOT_CDS(return false;)
444 }
445
446 bool validate_class_location();
447 bool validate_aot_class_linking();
448
449 #if INCLUDE_JVMTI
450 // Caller needs a ResourceMark because parts of the returned cfs are resource-allocated.
451 static ClassFileStream* open_stream_for_jvmti(InstanceKlass* ik, Handle class_loader, TRAPS);
452 static ClassFileStream* get_stream_from_class_loader(Handle class_loader,
453 ClassPathEntry* cpe,
454 const char* file_name,
455 TRAPS);
456 #endif
457
458 // The offset of the first core region in the archive, relative to SharedBaseAddress
459 size_t mapping_base_offset() const { return first_core_region()->mapping_offset(); }
460 // The offset of the (exclusive) end of the last core region in this archive, relative to SharedBaseAddress
461 size_t mapping_end_offset() const { return last_core_region()->mapping_end_offset(); }
462
463 char* mapped_base() const { return header()->mapped_base_address(); }
464 char* mapped_end() const { return last_core_region()->mapped_end(); }
465
466 // Non-zero if the archive needs to be mapped a non-default location due to ASLR.
467 intx relocation_delta() const {
468 return header()->mapped_base_address() - header()->requested_base_address();
469 }
470
471 FileMapRegion* first_core_region() const;
472 FileMapRegion* last_core_region() const;
473
474 FileMapRegion* region_at(int i) const {
475 return header()->region_at(i);
476 }
477
478 BitMapView bitmap_view(int region_index, bool is_oopmap);
479 BitMapView oopmap_view(int region_index);
480 BitMapView ptrmap_view(int region_index);
481
482 void print(outputStream* st) const;
483
484 const char* vm_version() {
485 return header()->jvm_ident();
486 }
487 bool can_use_heap_region();
488
489 private:
490 bool open_for_read();
491 void seek_to_position(size_t pos);
492
493 MapArchiveResult map_region(int i, intx addr_delta, char* mapped_base_address, ReservedSpace rs);
494 bool relocate_pointers_in_core_regions(intx addr_delta);
495 char* map_auxiliary_region(int region_index, bool read_only);
496
497 public:
498
499 private:
500
501 #if INCLUDE_JVMTI
502 static ClassPathEntry** _classpath_entries_for_jvmti;
503 static ClassPathEntry* get_classpath_entry_for_jvmti(int i, TRAPS);
504 #endif
505 };
506
507 #endif // SHARE_CDS_FILEMAP_HPP