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