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/archiveUtils.hpp" 29 #include "cds/metaspaceShared.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 MetaspaceShared::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 _allow_archiving_with_java_agent; // setting of the AllowArchivingWithJavaAgent option 139 bool _use_optimized_module_handling;// No module-relation VM options were specified, so we can skip 140 // some expensive operations. 141 bool _has_aot_linked_classes; // Was the CDS archive created with -XX:+AOTClassLinking 142 bool _has_full_module_graph; // Does this CDS archive contain the full archived module graph? 143 HeapRootSegments _heap_root_segments; // Heap root segments info 144 size_t _heap_oopmap_start_pos; // The first bit in the oopmap corresponds to this position in the heap. 145 size_t _heap_ptrmap_start_pos; // The first bit in the ptrmap corresponds to this position in the heap. 146 size_t _rw_ptrmap_start_pos; // The first bit in the ptrmap corresponds to this position in the rw region 147 size_t _ro_ptrmap_start_pos; // The first bit in the ptrmap corresponds to this position in the ro region 148 template <typename T> T from_mapped_offset(size_t offset) const { 149 return (T)(mapped_base_address() + offset); 150 } 151 void set_as_offset(char* p, size_t *offset); 152 template <typename T> void set_as_offset(T p, size_t *offset) { 153 set_as_offset((char*)p, offset); 154 } 155 156 public: 157 // Accessors -- fields declared in GenericCDSFileMapHeader 158 unsigned int magic() const { return _generic_header._magic; } 159 int crc() const { return _generic_header._crc; } 160 int version() const { return _generic_header._version; } 161 unsigned int header_size() const { return _generic_header._header_size; } 162 unsigned int base_archive_name_offset() const { return _generic_header._base_archive_name_offset; } 163 unsigned int base_archive_name_size() const { return _generic_header._base_archive_name_size; } 164 165 void set_magic(unsigned int m) { _generic_header._magic = m; } 166 void set_crc(int crc_value) { _generic_header._crc = crc_value; } 167 void set_version(int v) { _generic_header._version = v; } 168 void set_header_size(unsigned int s) { _generic_header._header_size = s; } 169 void set_base_archive_name_offset(unsigned int s) { _generic_header._base_archive_name_offset = s; } 170 void set_base_archive_name_size(unsigned int s) { _generic_header._base_archive_name_size = s; } 171 172 bool is_static() const { return magic() == CDS_ARCHIVE_MAGIC; } 173 size_t core_region_alignment() const { return _core_region_alignment; } 174 int obj_alignment() const { return _obj_alignment; } 175 address narrow_oop_base() const { return _narrow_oop_base; } 176 int narrow_oop_shift() const { return _narrow_oop_shift; } 177 bool compact_strings() const { return _compact_strings; } 178 bool compact_headers() const { return _compact_headers; } 179 uintx max_heap_size() const { return _max_heap_size; } 180 CompressedOops::Mode narrow_oop_mode() const { return _narrow_oop_mode; } 181 char* cloned_vtables() const { return from_mapped_offset<char*>(_cloned_vtables_offset); } 182 char* early_serialized_data() const { return from_mapped_offset<char*>(_early_serialized_data_offset); } 183 char* serialized_data() const { return from_mapped_offset<char*>(_serialized_data_offset); } 184 const char* jvm_ident() const { return _jvm_ident; } 185 char* requested_base_address() const { return _requested_base_address; } 186 char* mapped_base_address() const { return _mapped_base_address; } 187 bool has_platform_or_app_classes() const { return _has_platform_or_app_classes; } 188 bool has_aot_linked_classes() const { return _has_aot_linked_classes; } 189 bool compressed_oops() const { return _compressed_oops; } 190 bool compressed_class_pointers() const { return _compressed_class_ptrs; } 191 int narrow_klass_pointer_bits() const { return _narrow_klass_pointer_bits; } 192 int narrow_klass_shift() const { return _narrow_klass_shift; } 193 HeapRootSegments heap_root_segments() const { return _heap_root_segments; } 194 bool has_full_module_graph() const { return _has_full_module_graph; } 195 size_t heap_oopmap_start_pos() const { return _heap_oopmap_start_pos; } 196 size_t heap_ptrmap_start_pos() const { return _heap_ptrmap_start_pos; } 197 size_t rw_ptrmap_start_pos() const { return _rw_ptrmap_start_pos; } 198 size_t ro_ptrmap_start_pos() const { return _ro_ptrmap_start_pos; } 199 200 void set_has_platform_or_app_classes(bool v) { _has_platform_or_app_classes = v; } 201 void set_cloned_vtables(char* p) { set_as_offset(p, &_cloned_vtables_offset); } 202 void set_early_serialized_data(char* p) { set_as_offset(p, &_early_serialized_data_offset); } 203 void set_serialized_data(char* p) { set_as_offset(p, &_serialized_data_offset); } 204 void set_mapped_base_address(char* p) { _mapped_base_address = p; } 205 void set_heap_root_segments(HeapRootSegments segments) { _heap_root_segments = segments; } 206 void set_heap_oopmap_start_pos(size_t n) { _heap_oopmap_start_pos = n; } 207 void set_heap_ptrmap_start_pos(size_t n) { _heap_ptrmap_start_pos = n; } 208 void set_rw_ptrmap_start_pos(size_t n) { _rw_ptrmap_start_pos = n; } 209 void set_ro_ptrmap_start_pos(size_t n) { _ro_ptrmap_start_pos = n; } 210 void copy_base_archive_name(const char* name); 211 212 void set_class_location_config(AOTClassLocationConfig* table) { 213 set_as_offset(table, &_class_location_config_offset); 214 } 215 216 AOTClassLocationConfig* class_location_config() { 217 return from_mapped_offset<AOTClassLocationConfig*>(_class_location_config_offset); 218 } 219 220 void set_requested_base(char* b) { 221 _requested_base_address = b; 222 _mapped_base_address = nullptr; 223 } 224 225 bool validate(); 226 int compute_crc(); 227 228 FileMapRegion* region_at(int i) { 229 assert(is_valid_region(i), "invalid region"); 230 return FileMapRegion::cast(&_regions[i]); 231 } 232 233 void populate(FileMapInfo *info, size_t core_region_alignment, size_t header_size, 234 size_t base_archive_name_size, size_t base_archive_name_offset); 235 static bool is_valid_region(int region) { 236 return (0 <= region && region < NUM_CDS_REGIONS); 237 } 238 239 void print(outputStream* st); 240 }; 241 242 class FileMapInfo : public CHeapObj<mtInternal> { 243 private: 244 friend class ManifestStream; 245 friend class VMStructs; 246 friend class ArchiveBuilder; 247 friend class CDSOffsets; 248 friend class FileMapHeader; 249 250 bool _is_static; 251 bool _file_open; 252 bool _is_mapped; 253 int _fd; 254 size_t _file_offset; 255 const char* _full_path; 256 const char* _base_archive_name; 257 FileMapHeader* _header; 258 259 // FileMapHeader describes the shared space data in the file to be 260 // mapped. This structure gets written to a file. It is not a class, so 261 // that the compilers don't add any compiler-private data to it. 262 263 static FileMapInfo* _current_info; 264 static FileMapInfo* _dynamic_archive_info; 265 static bool _heap_pointers_need_patching; 266 static bool _memory_mapping_failed; 267 268 public: 269 FileMapHeader *header() const { return _header; } 270 static bool get_base_archive_name_from_header(const char* archive_name, 271 char** base_archive_name); 272 static bool is_preimage_static_archive(const char* file); 273 274 bool init_from_file(int fd); 275 276 void log_paths(const char* msg, int start_idx, int end_idx); 277 278 FileMapInfo(const char* full_apth, bool is_static); 279 ~FileMapInfo(); 280 static void free_current_info(); 281 282 // Accessors 283 int compute_header_crc() const { return header()->compute_crc(); } 284 void set_header_crc(int crc) { header()->set_crc(crc); } 285 int region_crc(int i) const { return region_at(i)->crc(); } 286 void populate_header(size_t core_region_alignment); 287 bool validate_header(); 288 void invalidate(); 289 int crc() const { return header()->crc(); } 290 int version() const { return header()->version(); } 291 unsigned int magic() const { return header()->magic(); } 292 address narrow_oop_base() const { return header()->narrow_oop_base(); } 293 int narrow_oop_shift() const { return header()->narrow_oop_shift(); } 294 uintx max_heap_size() const { return header()->max_heap_size(); } 295 HeapRootSegments heap_root_segments() const { return header()->heap_root_segments(); } 296 size_t core_region_alignment() const { return header()->core_region_alignment(); } 297 size_t heap_oopmap_start_pos() const { return header()->heap_oopmap_start_pos(); } 298 size_t heap_ptrmap_start_pos() const { return header()->heap_ptrmap_start_pos(); } 299 300 CompressedOops::Mode narrow_oop_mode() const { return header()->narrow_oop_mode(); } 301 302 char* cloned_vtables() const { return header()->cloned_vtables(); } 303 void set_cloned_vtables(char* p) const { header()->set_cloned_vtables(p); } 304 char* early_serialized_data() const { return header()->early_serialized_data(); } 305 void set_early_serialized_data(char* p) const { header()->set_early_serialized_data(p); } 306 char* serialized_data() const { return header()->serialized_data(); } 307 void set_serialized_data(char* p) const { header()->set_serialized_data(p); } 308 309 bool is_file_position_aligned() const; 310 void align_file_position(); 311 312 bool is_static() const { return _is_static; } 313 bool is_mapped() const { return _is_mapped; } 314 void set_is_mapped(bool v) { _is_mapped = v; } 315 const char* full_path() const { return _full_path; } 316 317 void set_requested_base(char* b) { header()->set_requested_base(b); } 318 char* requested_base_address() const { return header()->requested_base_address(); } 319 320 class DynamicArchiveHeader* dynamic_header() const { 321 assert(!is_static(), "must be"); 322 return (DynamicArchiveHeader*)header(); 323 } 324 325 void set_has_platform_or_app_classes(bool v) { 326 header()->set_has_platform_or_app_classes(v); 327 } 328 bool has_platform_or_app_classes() const { 329 return header()->has_platform_or_app_classes(); 330 } 331 332 static FileMapInfo* current_info() { 333 CDS_ONLY(return _current_info;) 334 NOT_CDS(return nullptr;) 335 } 336 337 static void set_current_info(FileMapInfo* info) { 338 CDS_ONLY(_current_info = info;) 339 } 340 341 static FileMapInfo* dynamic_info() { 342 CDS_ONLY(return _dynamic_archive_info;) 343 NOT_CDS(return nullptr;) 344 } 345 346 static void assert_mark(bool check); 347 348 // File manipulation. 349 bool initialize() NOT_CDS_RETURN_(false); 350 bool open_for_read(); 351 void open_for_write(); 352 void write_header(); 353 void write_region(int region, char* base, size_t size, 354 bool read_only, bool allow_exec); 355 size_t remove_bitmap_zeros(CHeapBitMap* map); 356 char* write_bitmap_region(CHeapBitMap* rw_ptrmap, CHeapBitMap* ro_ptrmap, ArchiveHeapInfo* heap_info, 357 size_t &size_in_bytes); 358 size_t write_heap_region(ArchiveHeapInfo* heap_info); 359 void write_bytes(const void* buffer, size_t count); 360 void write_bytes_aligned(const void* buffer, size_t count); 361 size_t read_bytes(void* buffer, size_t count); 362 static size_t readonly_total(); 363 MapArchiveResult map_regions(int regions[], int num_regions, char* mapped_base_address, ReservedSpace rs); 364 void unmap_regions(int regions[], int num_regions); 365 void map_or_load_heap_region() NOT_CDS_JAVA_HEAP_RETURN; 366 void fixup_mapped_heap_region() NOT_CDS_JAVA_HEAP_RETURN; 367 void patch_heap_embedded_pointers() NOT_CDS_JAVA_HEAP_RETURN; 368 bool has_heap_region() NOT_CDS_JAVA_HEAP_RETURN_(false); 369 MemRegion get_heap_region_requested_range() NOT_CDS_JAVA_HEAP_RETURN_(MemRegion()); 370 bool read_region(int i, char* base, size_t size, bool do_commit); 371 char* map_bitmap_region(); 372 void unmap_region(int i); 373 void close(); 374 bool is_open() { return _file_open; } 375 376 // JVM/TI RedefineClasses() support: 377 // Remap the shared readonly space to shared readwrite, private. 378 bool remap_shared_readonly_as_readwrite(); 379 380 static bool memory_mapping_failed() { 381 CDS_ONLY(return _memory_mapping_failed;) 382 NOT_CDS(return false;) 383 } 384 385 bool validate_class_location(); 386 bool validate_aot_class_linking(); 387 388 #if INCLUDE_JVMTI 389 // Caller needs a ResourceMark because parts of the returned cfs are resource-allocated. 390 static ClassFileStream* open_stream_for_jvmti(InstanceKlass* ik, Handle class_loader, TRAPS); 391 static ClassFileStream* get_stream_from_class_loader(Handle class_loader, 392 ClassPathEntry* cpe, 393 const char* file_name, 394 TRAPS); 395 #endif 396 397 // The offset of the first core region in the archive, relative to SharedBaseAddress 398 size_t mapping_base_offset() const { return first_core_region()->mapping_offset(); } 399 // The offset of the (exclusive) end of the last core region in this archive, relative to SharedBaseAddress 400 size_t mapping_end_offset() const { return last_core_region()->mapping_end_offset(); } 401 402 char* mapped_base() const { return first_core_region()->mapped_base(); } 403 char* mapped_end() const { return last_core_region()->mapped_end(); } 404 405 // Non-zero if the archive needs to be mapped a non-default location due to ASLR. 406 intx relocation_delta() const { 407 return header()->mapped_base_address() - header()->requested_base_address(); 408 } 409 410 FileMapRegion* first_core_region() const; 411 FileMapRegion* last_core_region() const; 412 413 FileMapRegion* region_at(int i) const { 414 return header()->region_at(i); 415 } 416 417 BitMapView bitmap_view(int region_index, bool is_oopmap); 418 BitMapView oopmap_view(int region_index); 419 BitMapView ptrmap_view(int region_index); 420 421 void print(outputStream* st) const; 422 423 const char* vm_version() { 424 return header()->jvm_ident(); 425 } 426 427 private: 428 void seek_to_position(size_t pos); 429 bool map_heap_region_impl() NOT_CDS_JAVA_HEAP_RETURN_(false); 430 void dealloc_heap_region() NOT_CDS_JAVA_HEAP_RETURN; 431 bool can_use_heap_region(); 432 bool load_heap_region() NOT_CDS_JAVA_HEAP_RETURN_(false); 433 bool map_heap_region() NOT_CDS_JAVA_HEAP_RETURN_(false); 434 void init_heap_region_relocation(); 435 MapArchiveResult map_region(int i, intx addr_delta, char* mapped_base_address, ReservedSpace rs); 436 bool relocate_pointers_in_core_regions(intx addr_delta); 437 438 static MemRegion _mapped_heap_memregion; 439 440 public: 441 address heap_region_dumptime_address() NOT_CDS_JAVA_HEAP_RETURN_(nullptr); 442 address heap_region_requested_address() NOT_CDS_JAVA_HEAP_RETURN_(nullptr); 443 narrowOop encoded_heap_region_dumptime_address(); 444 445 private: 446 447 #if INCLUDE_JVMTI 448 static ClassPathEntry** _classpath_entries_for_jvmti; 449 static ClassPathEntry* get_classpath_entry_for_jvmti(int i, TRAPS); 450 #endif 451 }; 452 453 #endif // SHARE_CDS_FILEMAP_HPP