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