1 /* 2 * Copyright (c) 2003, 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 #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 "runtime/globals.hpp" 36 #include "utilities/align.hpp" 37 38 // To understand the layout of the CDS archive file: 39 // 40 // java -Xlog:cds+map=info:file=cds.map:none:filesize=0 41 // java -Xlog:cds+map=debug:file=cds.map:none:filesize=0 42 // java -Xlog:cds+map=trace:file=cds.map:none:filesize=0 43 44 static const int JVM_IDENT_MAX = 256; 45 46 class ArchiveHeapInfo; 47 class BitMapView; 48 class CHeapBitMap; 49 class ClassFileStream; 50 class ClassLoaderData; 51 class ClassPathEntry; 52 class outputStream; 53 54 class SharedClassPathEntry : public MetaspaceObj { 55 enum { 56 modules_image_entry, 57 jar_entry, 58 dir_entry, 59 non_existent_entry, 60 unknown_entry 61 }; 62 63 void set_name(const char* name, TRAPS); 64 65 u1 _type; 66 bool _is_module_path; 67 bool _from_class_path_attr; 68 time_t _timestamp; // jar timestamp, 0 if is directory, modules image or other 69 int64_t _filesize; // jar/jimage file size, -1 if is directory, -2 if other 70 Array<char>* _name; 71 Array<u1>* _manifest; 72 73 public: 74 SharedClassPathEntry() : _type(0), _is_module_path(false), 75 _from_class_path_attr(false), _timestamp(0), 76 _filesize(0), _name(nullptr), _manifest(nullptr) {} 77 static int size() { 78 static_assert(is_aligned(sizeof(SharedClassPathEntry), wordSize), "must be"); 79 return (int)(sizeof(SharedClassPathEntry) / wordSize); 80 } 81 void init(bool is_modules_image, bool is_module_path, ClassPathEntry* cpe, TRAPS); 82 void init_as_non_existent(const char* path, TRAPS); 83 void metaspace_pointers_do(MetaspaceClosure* it); 84 MetaspaceObj::Type type() const { return SharedClassPathEntryType; } 85 bool validate(bool is_class_path = true) const; 86 87 // The _timestamp only gets set for jar files. 88 bool has_timestamp() const { 89 return _timestamp != 0; 90 } 91 bool is_dir() const { return _type == dir_entry; } 92 bool is_modules_image() const { return _type == modules_image_entry; } 93 bool is_jar() const { return _type == jar_entry; } 94 bool is_non_existent() const { return _type == non_existent_entry; } 95 bool from_class_path_attr() { return _from_class_path_attr; } 96 time_t timestamp() const { return _timestamp; } 97 const char* name() const; 98 const char* manifest() const { 99 return (_manifest == nullptr) ? nullptr : (const char*)_manifest->data(); 100 } 101 int manifest_size() const { 102 return (_manifest == nullptr) ? 0 : _manifest->length(); 103 } 104 void set_manifest(Array<u1>* manifest) { 105 _manifest = manifest; 106 } 107 bool check_non_existent() const; 108 void copy_from(SharedClassPathEntry* ent, ClassLoaderData* loader_data, TRAPS); 109 bool in_named_module() { 110 return is_modules_image() || // modules image doesn't contain unnamed modules 111 _is_module_path; // module path doesn't contain unnamed modules 112 } 113 }; 114 115 class SharedPathTable { 116 Array<SharedClassPathEntry*>* _entries; 117 public: 118 SharedPathTable() : _entries(nullptr) {} 119 SharedPathTable(Array<SharedClassPathEntry*>* entries) : _entries(entries) {} 120 121 void dumptime_init(ClassLoaderData* loader_data, TRAPS); 122 void metaspace_pointers_do(MetaspaceClosure* it); 123 124 int size() { 125 return _entries == nullptr ? 0 : _entries->length(); 126 } 127 SharedClassPathEntry* path_at(int index) { 128 return _entries->at(index); 129 } 130 Array<SharedClassPathEntry*>* table() {return _entries;} 131 void set_table(Array<SharedClassPathEntry*>* table) {_entries = table;} 132 }; 133 134 135 class FileMapRegion: private CDSFileMapRegion { 136 public: 137 void assert_is_heap_region() const { 138 assert(_is_heap_region, "must be heap region"); 139 } 140 void assert_is_not_heap_region() const { 141 assert(!_is_heap_region, "must not be heap region"); 142 } 143 144 static FileMapRegion* cast(CDSFileMapRegion* p) { 145 return (FileMapRegion*)p; 146 } 147 148 // Accessors 149 int crc() const { return _crc; } 150 size_t file_offset() const { return _file_offset; } 151 size_t mapping_offset() const { return _mapping_offset; } 152 size_t mapping_end_offset() const { return _mapping_offset + used_aligned(); } 153 size_t used() const { return _used; } 154 size_t used_aligned() const; // aligned up to MetaspaceShared::core_region_alignment() 155 char* mapped_base() const { return _mapped_base; } 156 char* mapped_end() const { return mapped_base() + used_aligned(); } 157 bool read_only() const { return _read_only != 0; } 158 bool allow_exec() const { return _allow_exec != 0; } 159 bool mapped_from_file() const { return _mapped_from_file != 0; } 160 size_t oopmap_offset() const { assert_is_heap_region(); return _oopmap_offset; } 161 size_t oopmap_size_in_bits() const { assert_is_heap_region(); return _oopmap_size_in_bits; } 162 size_t ptrmap_offset() const { return _ptrmap_offset; } 163 size_t ptrmap_size_in_bits() const { return _ptrmap_size_in_bits; } 164 165 void set_file_offset(size_t s) { _file_offset = s; } 166 void set_read_only(bool v) { _read_only = v; } 167 void set_mapped_base(char* p) { _mapped_base = p; } 168 void set_mapped_from_file(bool v) { _mapped_from_file = v; } 169 void init(int region_index, size_t mapping_offset, size_t size, bool read_only, 170 bool allow_exec, int crc); 171 void init_oopmap(size_t offset, size_t size_in_bits); 172 void init_ptrmap(size_t offset, size_t size_in_bits); 173 bool has_ptrmap() { return _ptrmap_size_in_bits != 0; } 174 175 bool check_region_crc(char* base) const; 176 void print(outputStream* st, int region_index); 177 }; 178 179 #define CDS_MUST_MATCH_FLAGS_DO(f) \ 180 f(EnableValhalla) \ 181 f(FlatArrayElementMaxOops) \ 182 f(FlatArrayElementMaxSize) \ 183 f(InlineFieldMaxFlatSize) \ 184 f(InlineTypePassFieldsAsArgs) \ 185 f(InlineTypeReturnedAsFields) \ 186 f(AtomicFieldFlattening) \ 187 f(NullableFieldFlattening) 188 189 class CDSMustMatchFlags { 190 private: 191 size_t _max_name_width; 192 #define DECLARE_CDS_MUST_MATCH_FLAG(n) \ 193 decltype(n) _v_##n; 194 CDS_MUST_MATCH_FLAGS_DO(DECLARE_CDS_MUST_MATCH_FLAG); 195 #undef DECLARE_CDS_MUST_MATCH_FLAG 196 197 inline static void do_print(outputStream* st, bool v); 198 inline static void do_print(outputStream* st, intx v); 199 inline static void do_print(outputStream* st, uintx v); 200 inline static void do_print(outputStream* st, double v); 201 void print_info() const; 202 203 public: 204 void init(); 205 bool runtime_check() const; 206 void print(outputStream* st) const; 207 }; 208 209 class FileMapHeader: private CDSFileMapHeaderBase { 210 friend class CDSConstants; 211 friend class VMStructs; 212 213 private: 214 // The following fields record the states of the VM during dump time. 215 // They are compared with the runtime states to see if the archive 216 // can be used. 217 size_t _core_region_alignment; // how shared archive should be aligned 218 int _obj_alignment; // value of ObjectAlignmentInBytes 219 address _narrow_oop_base; // compressed oop encoding base 220 int _narrow_oop_shift; // compressed oop encoding shift 221 bool _compact_strings; // value of CompactStrings 222 uintx _max_heap_size; // java max heap size during dumping 223 CompressedOops::Mode _narrow_oop_mode; // compressed oop encoding mode 224 bool _compressed_oops; // save the flag UseCompressedOops 225 bool _compressed_class_ptrs; // save the flag UseCompressedClassPointers 226 size_t _cloned_vtables_offset; // The address of the first cloned vtable 227 size_t _serialized_data_offset; // Data accessed using {ReadClosure,WriteClosure}::serialize() 228 bool _has_non_jar_in_classpath; // non-jar file entry exists in classpath 229 unsigned int _common_app_classpath_prefix_size; // size of the common prefix of app class paths 230 // 0 if no common prefix exists 231 232 // The following fields are all sanity checks for whether this archive 233 // will function correctly with this JVM and the bootclasspath it's 234 // invoked with. 235 char _jvm_ident[JVM_IDENT_MAX]; // identifier string of the jvm that created this dump 236 237 // The following is a table of all the boot/app/module path entries that were used 238 // during dumping. At run time, we validate these entries according to their 239 // SharedClassPathEntry::_type. See: 240 // check_nonempty_dir_in_shared_path_table() 241 // validate_shared_path_table() 242 // validate_non_existent_class_paths() 243 size_t _shared_path_table_offset; 244 245 jshort _app_class_paths_start_index; // Index of first app classpath entry 246 jshort _app_module_paths_start_index; // Index of first module path entry 247 jshort _max_used_path_index; // max path index referenced during CDS dump 248 int _num_module_paths; // number of module path entries 249 bool _verify_local; // BytecodeVerificationLocal setting 250 bool _verify_remote; // BytecodeVerificationRemote setting 251 bool _has_platform_or_app_classes; // Archive contains app classes 252 char* _requested_base_address; // Archive relocation is not necessary if we map with this base address. 253 char* _mapped_base_address; // Actual base address where archive is mapped. 254 255 bool _allow_archiving_with_java_agent; // setting of the AllowArchivingWithJavaAgent option 256 bool _use_optimized_module_handling;// No module-relation VM options were specified, so we can skip 257 // some expensive operations. 258 bool _has_full_module_graph; // Does this CDS archive contain the full archived module graph? 259 bool _has_valhalla_patched_classes; // Is this archived dumped with --enable-preview -XX:+EnableValhalla? 260 CDSMustMatchFlags _must_match; // These flags must be the same between dumptime and runtime 261 HeapRootSegments _heap_root_segments; // Heap root segments info 262 size_t _heap_oopmap_start_pos; // The first bit in the oopmap corresponds to this position in the heap. 263 size_t _heap_ptrmap_start_pos; // The first bit in the ptrmap corresponds to this position in the heap. 264 size_t _rw_ptrmap_start_pos; // The first bit in the ptrmap corresponds to this position in the rw region 265 size_t _ro_ptrmap_start_pos; // The first bit in the ptrmap corresponds to this position in the ro region 266 char* from_mapped_offset(size_t offset) const { 267 return mapped_base_address() + offset; 268 } 269 void set_as_offset(char* p, size_t *offset); 270 public: 271 // Accessors -- fields declared in GenericCDSFileMapHeader 272 unsigned int magic() const { return _generic_header._magic; } 273 int crc() const { return _generic_header._crc; } 274 int version() const { return _generic_header._version; } 275 unsigned int header_size() const { return _generic_header._header_size; } 276 unsigned int base_archive_name_offset() const { return _generic_header._base_archive_name_offset; } 277 unsigned int base_archive_name_size() const { return _generic_header._base_archive_name_size; } 278 unsigned int common_app_classpath_prefix_size() const { return _common_app_classpath_prefix_size; } 279 280 void set_magic(unsigned int m) { _generic_header._magic = m; } 281 void set_crc(int crc_value) { _generic_header._crc = crc_value; } 282 void set_version(int v) { _generic_header._version = v; } 283 void set_header_size(unsigned int s) { _generic_header._header_size = s; } 284 void set_base_archive_name_offset(unsigned int s) { _generic_header._base_archive_name_offset = s; } 285 void set_base_archive_name_size(unsigned int s) { _generic_header._base_archive_name_size = s; } 286 void set_common_app_classpath_prefix_size(unsigned int s) { _common_app_classpath_prefix_size = s; } 287 288 bool is_static() const { return magic() == CDS_ARCHIVE_MAGIC; } 289 size_t core_region_alignment() const { return _core_region_alignment; } 290 int obj_alignment() const { return _obj_alignment; } 291 address narrow_oop_base() const { return _narrow_oop_base; } 292 int narrow_oop_shift() const { return _narrow_oop_shift; } 293 bool compact_strings() const { return _compact_strings; } 294 uintx max_heap_size() const { return _max_heap_size; } 295 CompressedOops::Mode narrow_oop_mode() const { return _narrow_oop_mode; } 296 char* cloned_vtables() const { return from_mapped_offset(_cloned_vtables_offset); } 297 char* serialized_data() const { return from_mapped_offset(_serialized_data_offset); } 298 const char* jvm_ident() const { return _jvm_ident; } 299 char* requested_base_address() const { return _requested_base_address; } 300 char* mapped_base_address() const { return _mapped_base_address; } 301 bool has_platform_or_app_classes() const { return _has_platform_or_app_classes; } 302 bool has_non_jar_in_classpath() const { return _has_non_jar_in_classpath; } 303 bool compressed_oops() const { return _compressed_oops; } 304 bool compressed_class_pointers() const { return _compressed_class_ptrs; } 305 HeapRootSegments heap_root_segments() const { return _heap_root_segments; } 306 bool has_full_module_graph() const { return _has_full_module_graph; } 307 size_t heap_oopmap_start_pos() const { return _heap_oopmap_start_pos; } 308 size_t heap_ptrmap_start_pos() const { return _heap_ptrmap_start_pos; } 309 size_t rw_ptrmap_start_pos() const { return _rw_ptrmap_start_pos; } 310 size_t ro_ptrmap_start_pos() const { return _ro_ptrmap_start_pos; } 311 // FIXME: These should really return int 312 jshort max_used_path_index() const { return _max_used_path_index; } 313 jshort app_module_paths_start_index() const { return _app_module_paths_start_index; } 314 jshort app_class_paths_start_index() const { return _app_class_paths_start_index; } 315 int num_module_paths() const { return _num_module_paths; } 316 317 void set_has_platform_or_app_classes(bool v) { _has_platform_or_app_classes = v; } 318 void set_cloned_vtables(char* p) { set_as_offset(p, &_cloned_vtables_offset); } 319 void set_serialized_data(char* p) { set_as_offset(p, &_serialized_data_offset); } 320 void set_mapped_base_address(char* p) { _mapped_base_address = p; } 321 void set_heap_root_segments(HeapRootSegments segments) { _heap_root_segments = segments; } 322 void set_heap_oopmap_start_pos(size_t n) { _heap_oopmap_start_pos = n; } 323 void set_heap_ptrmap_start_pos(size_t n) { _heap_ptrmap_start_pos = n; } 324 void set_rw_ptrmap_start_pos(size_t n) { _rw_ptrmap_start_pos = n; } 325 void set_ro_ptrmap_start_pos(size_t n) { _ro_ptrmap_start_pos = n; } 326 void copy_base_archive_name(const char* name); 327 328 void set_shared_path_table(SharedPathTable table) { 329 set_as_offset((char*)table.table(), &_shared_path_table_offset); 330 } 331 332 void set_requested_base(char* b) { 333 _requested_base_address = b; 334 _mapped_base_address = nullptr; 335 } 336 337 SharedPathTable shared_path_table() const { 338 return SharedPathTable((Array<SharedClassPathEntry*>*) 339 from_mapped_offset(_shared_path_table_offset)); 340 } 341 342 bool validate(); 343 int compute_crc(); 344 345 FileMapRegion* region_at(int i) { 346 assert(is_valid_region(i), "invalid region"); 347 return FileMapRegion::cast(&_regions[i]); 348 } 349 350 void populate(FileMapInfo *info, size_t core_region_alignment, size_t header_size, 351 size_t base_archive_name_size, size_t base_archive_name_offset, 352 size_t common_app_classpath_size); 353 static bool is_valid_region(int region) { 354 return (0 <= region && region < NUM_CDS_REGIONS); 355 } 356 357 bool check_must_match_flags() const { 358 return _must_match.runtime_check(); 359 } 360 361 void print(outputStream* st); 362 }; 363 364 class FileMapInfo : public CHeapObj<mtInternal> { 365 private: 366 friend class ManifestStream; 367 friend class VMStructs; 368 friend class ArchiveBuilder; 369 friend class CDSOffsets; 370 friend class FileMapHeader; 371 372 bool _is_static; 373 bool _file_open; 374 bool _is_mapped; 375 int _fd; 376 size_t _file_offset; 377 const char* _full_path; 378 const char* _base_archive_name; 379 FileMapHeader* _header; 380 381 static SharedPathTable _shared_path_table; 382 static bool _validating_shared_path_table; 383 384 // FileMapHeader describes the shared space data in the file to be 385 // mapped. This structure gets written to a file. It is not a class, so 386 // that the compilers don't add any compiler-private data to it. 387 388 static FileMapInfo* _current_info; 389 static FileMapInfo* _dynamic_archive_info; 390 static bool _heap_pointers_need_patching; 391 static bool _memory_mapping_failed; 392 static GrowableArray<const char*>* _non_existent_class_paths; 393 394 public: 395 FileMapHeader *header() const { return _header; } 396 static bool get_base_archive_name_from_header(const char* archive_name, 397 char** base_archive_name); 398 static SharedPathTable shared_path_table() { 399 return _shared_path_table; 400 } 401 402 bool init_from_file(int fd); 403 static void metaspace_pointers_do(MetaspaceClosure* it) { 404 _shared_path_table.metaspace_pointers_do(it); 405 } 406 407 void log_paths(const char* msg, int start_idx, int end_idx); 408 409 FileMapInfo(const char* full_apth, bool is_static); 410 ~FileMapInfo(); 411 412 // Accessors 413 int compute_header_crc() const { return header()->compute_crc(); } 414 void set_header_crc(int crc) { header()->set_crc(crc); } 415 int region_crc(int i) const { return region_at(i)->crc(); } 416 void populate_header(size_t core_region_alignment); 417 bool validate_header(); 418 void invalidate(); 419 int crc() const { return header()->crc(); } 420 int version() const { return header()->version(); } 421 unsigned int magic() const { return header()->magic(); } 422 address narrow_oop_base() const { return header()->narrow_oop_base(); } 423 int narrow_oop_shift() const { return header()->narrow_oop_shift(); } 424 uintx max_heap_size() const { return header()->max_heap_size(); } 425 HeapRootSegments heap_root_segments() const { return header()->heap_root_segments(); } 426 size_t core_region_alignment() const { return header()->core_region_alignment(); } 427 size_t heap_oopmap_start_pos() const { return header()->heap_oopmap_start_pos(); } 428 size_t heap_ptrmap_start_pos() const { return header()->heap_ptrmap_start_pos(); } 429 430 CompressedOops::Mode narrow_oop_mode() const { return header()->narrow_oop_mode(); } 431 jshort app_module_paths_start_index() const { return header()->app_module_paths_start_index(); } 432 jshort app_class_paths_start_index() const { return header()->app_class_paths_start_index(); } 433 434 char* cloned_vtables() const { return header()->cloned_vtables(); } 435 void set_cloned_vtables(char* p) const { header()->set_cloned_vtables(p); } 436 char* serialized_data() const { return header()->serialized_data(); } 437 void set_serialized_data(char* p) const { header()->set_serialized_data(p); } 438 439 bool is_file_position_aligned() const; 440 void align_file_position(); 441 442 bool is_static() const { return _is_static; } 443 bool is_mapped() const { return _is_mapped; } 444 void set_is_mapped(bool v) { _is_mapped = v; } 445 const char* full_path() const { return _full_path; } 446 447 void set_requested_base(char* b) { header()->set_requested_base(b); } 448 char* requested_base_address() const { return header()->requested_base_address(); } 449 450 class DynamicArchiveHeader* dynamic_header() const { 451 assert(!is_static(), "must be"); 452 return (DynamicArchiveHeader*)header(); 453 } 454 455 void set_has_platform_or_app_classes(bool v) { 456 header()->set_has_platform_or_app_classes(v); 457 } 458 bool has_platform_or_app_classes() const { 459 return header()->has_platform_or_app_classes(); 460 } 461 462 static FileMapInfo* current_info() { 463 CDS_ONLY(return _current_info;) 464 NOT_CDS(return nullptr;) 465 } 466 467 static void set_current_info(FileMapInfo* info) { 468 CDS_ONLY(_current_info = info;) 469 } 470 471 static FileMapInfo* dynamic_info() { 472 CDS_ONLY(return _dynamic_archive_info;) 473 NOT_CDS(return nullptr;) 474 } 475 476 static void assert_mark(bool check); 477 478 // File manipulation. 479 bool initialize() NOT_CDS_RETURN_(false); 480 bool open_for_read(); 481 void open_for_write(); 482 void write_header(); 483 void write_region(int region, char* base, size_t size, 484 bool read_only, bool allow_exec); 485 size_t remove_bitmap_zeros(CHeapBitMap* map); 486 char* write_bitmap_region(CHeapBitMap* rw_ptrmap, CHeapBitMap* ro_ptrmap, ArchiveHeapInfo* heap_info, 487 size_t &size_in_bytes); 488 size_t write_heap_region(ArchiveHeapInfo* heap_info); 489 void write_bytes(const void* buffer, size_t count); 490 void write_bytes_aligned(const void* buffer, size_t count); 491 size_t read_bytes(void* buffer, size_t count); 492 static size_t readonly_total(); 493 MapArchiveResult map_regions(int regions[], int num_regions, char* mapped_base_address, ReservedSpace rs); 494 void unmap_regions(int regions[], int num_regions); 495 void map_or_load_heap_region() NOT_CDS_JAVA_HEAP_RETURN; 496 void fixup_mapped_heap_region() NOT_CDS_JAVA_HEAP_RETURN; 497 void patch_heap_embedded_pointers() NOT_CDS_JAVA_HEAP_RETURN; 498 bool has_heap_region() NOT_CDS_JAVA_HEAP_RETURN_(false); 499 MemRegion get_heap_region_requested_range() NOT_CDS_JAVA_HEAP_RETURN_(MemRegion()); 500 bool read_region(int i, char* base, size_t size, bool do_commit); 501 char* map_bitmap_region(); 502 void unmap_region(int i); 503 void close(); 504 bool is_open() { return _file_open; } 505 ReservedSpace reserve_shared_memory(); 506 507 // JVM/TI RedefineClasses() support: 508 // Remap the shared readonly space to shared readwrite, private. 509 bool remap_shared_readonly_as_readwrite(); 510 511 static bool memory_mapping_failed() { 512 CDS_ONLY(return _memory_mapping_failed;) 513 NOT_CDS(return false;) 514 } 515 516 static void allocate_shared_path_table(TRAPS); 517 static int add_shared_classpaths(int i, const char* which, ClassPathEntry *cpe, TRAPS); 518 static void check_nonempty_dir_in_shared_path_table(); 519 bool check_module_paths(); 520 bool validate_shared_path_table(); 521 void validate_non_existent_class_paths(); 522 static void set_shared_path_table(FileMapInfo* info) { 523 _shared_path_table = info->header()->shared_path_table(); 524 } 525 static void update_jar_manifest(ClassPathEntry *cpe, SharedClassPathEntry* ent, TRAPS); 526 static int num_non_existent_class_paths(); 527 static void record_non_existent_class_path_entry(const char* path); 528 529 #if INCLUDE_JVMTI 530 // Caller needs a ResourceMark because parts of the returned cfs are resource-allocated. 531 static ClassFileStream* open_stream_for_jvmti(InstanceKlass* ik, Handle class_loader, TRAPS); 532 #endif 533 534 static SharedClassPathEntry* shared_path(int index) { 535 return _shared_path_table.path_at(index); 536 } 537 538 static const char* shared_path_name(int index) { 539 assert(index >= 0, "Sanity"); 540 return shared_path(index)->name(); 541 } 542 543 static int get_number_of_shared_paths() { 544 return _shared_path_table.size(); 545 } 546 547 static int get_module_shared_path_index(Symbol* location) NOT_CDS_RETURN_(-1); 548 549 // The offset of the first core region in the archive, relative to SharedBaseAddress 550 size_t mapping_base_offset() const { return first_core_region()->mapping_offset(); } 551 // The offset of the (exclusive) end of the last core region in this archive, relative to SharedBaseAddress 552 size_t mapping_end_offset() const { return last_core_region()->mapping_end_offset(); } 553 554 char* mapped_base() const { return first_core_region()->mapped_base(); } 555 char* mapped_end() const { return last_core_region()->mapped_end(); } 556 557 // Non-zero if the archive needs to be mapped a non-default location due to ASLR. 558 intx relocation_delta() const { 559 return header()->mapped_base_address() - header()->requested_base_address(); 560 } 561 562 FileMapRegion* first_core_region() const; 563 FileMapRegion* last_core_region() const; 564 565 FileMapRegion* region_at(int i) const { 566 return header()->region_at(i); 567 } 568 569 BitMapView bitmap_view(int region_index, bool is_oopmap); 570 BitMapView oopmap_view(int region_index); 571 BitMapView ptrmap_view(int region_index); 572 573 void print(outputStream* st) const; 574 575 const char* vm_version() { 576 return header()->jvm_ident(); 577 } 578 579 private: 580 void seek_to_position(size_t pos); 581 char* skip_first_path_entry(const char* path) NOT_CDS_RETURN_(nullptr); 582 int num_paths(const char* path) NOT_CDS_RETURN_(0); 583 bool check_paths_existence(const char* paths) NOT_CDS_RETURN_(false); 584 GrowableArray<const char*>* create_dumptime_app_classpath_array() NOT_CDS_RETURN_(nullptr); 585 GrowableArray<const char*>* create_path_array(const char* path) NOT_CDS_RETURN_(nullptr); 586 bool classpath_failure(const char* msg, const char* name) NOT_CDS_RETURN_(false); 587 unsigned int longest_common_app_classpath_prefix_len(int num_paths, 588 GrowableArray<const char*>* rp_array) 589 NOT_CDS_RETURN_(0); 590 bool check_paths(int shared_path_start_idx, int num_paths, 591 GrowableArray<const char*>* rp_array, 592 unsigned int dumptime_prefix_len, 593 unsigned int runtime_prefix_len) NOT_CDS_RETURN_(false); 594 void extract_module_paths(const char* runtime_path, GrowableArray<const char*>* module_paths); 595 bool validate_boot_class_paths() NOT_CDS_RETURN_(false); 596 bool validate_app_class_paths(int shared_app_paths_len) NOT_CDS_RETURN_(false); 597 bool map_heap_region_impl() NOT_CDS_JAVA_HEAP_RETURN_(false); 598 void dealloc_heap_region() NOT_CDS_JAVA_HEAP_RETURN; 599 bool can_use_heap_region(); 600 bool load_heap_region() NOT_CDS_JAVA_HEAP_RETURN_(false); 601 bool map_heap_region() NOT_CDS_JAVA_HEAP_RETURN_(false); 602 void init_heap_region_relocation(); 603 MapArchiveResult map_region(int i, intx addr_delta, char* mapped_base_address, ReservedSpace rs); 604 bool relocate_pointers_in_core_regions(intx addr_delta); 605 606 static MemRegion _mapped_heap_memregion; 607 608 public: 609 address heap_region_dumptime_address() NOT_CDS_JAVA_HEAP_RETURN_(nullptr); 610 address heap_region_requested_address() NOT_CDS_JAVA_HEAP_RETURN_(nullptr); 611 narrowOop encoded_heap_region_dumptime_address(); 612 613 private: 614 615 #if INCLUDE_JVMTI 616 static ClassPathEntry** _classpath_entries_for_jvmti; 617 static ClassPathEntry* get_classpath_entry_for_jvmti(int i, TRAPS); 618 #endif 619 }; 620 621 #endif // SHARE_CDS_FILEMAP_HPP