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