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