1 /*
  2  * Copyright (c) 2003, 2023, 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 from_class_path_attr() { return _from_class_path_attr; }
 93   time_t timestamp() const { return _timestamp; }
 94   const char* name() const;
 95   const char* manifest() const {
 96     return (_manifest == nullptr) ? nullptr : (const char*)_manifest->data();
 97   }
 98   int manifest_size() const {
 99     return (_manifest == nullptr) ? 0 : _manifest->length();
100   }
101   void set_manifest(Array<u1>* manifest) {
102     _manifest = manifest;
103   }
104   bool check_non_existent() const;
105   void copy_from(SharedClassPathEntry* ent, ClassLoaderData* loader_data, TRAPS);
106   bool in_named_module() {
107     return is_modules_image() || // modules image doesn't contain unnamed modules
108            _is_module_path;      // module path doesn't contain unnamed modules
109   }
110 };
111 
112 class SharedPathTable {
113   Array<SharedClassPathEntry*>* _entries;
114 public:
115   SharedPathTable() : _entries(nullptr) {}
116   SharedPathTable(Array<SharedClassPathEntry*>* entries) : _entries(entries) {}
117 
118   void dumptime_init(ClassLoaderData* loader_data, TRAPS);
119   void metaspace_pointers_do(MetaspaceClosure* it);
120 
121   int size() {
122     return _entries == nullptr ? 0 : _entries->length();
123   }
124   SharedClassPathEntry* path_at(int index) {
125     return _entries->at(index);
126   }
127   Array<SharedClassPathEntry*>* table() {return _entries;}
128   void set_table(Array<SharedClassPathEntry*>* table) {_entries = table;}
129 };
130 
131 
132 class FileMapRegion: private CDSFileMapRegion {
133   BitMapView bitmap_view(bool is_oopmap);
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 
161   void set_file_offset(size_t s)     { _file_offset = s; }
162   void set_read_only(bool v)         { _read_only = v; }
163   void set_mapped_base(char* p)      { _mapped_base = p; }
164   void set_mapped_from_file(bool v)  { _mapped_from_file = v; }
165   void init(int region_index, size_t mapping_offset, size_t size, bool read_only,
166             bool allow_exec, int crc);
167   void init_oopmap(size_t offset, size_t size_in_bits);
168   void init_ptrmap(size_t offset, size_t size_in_bits);
169   BitMapView oopmap_view();
170   BitMapView ptrmap_view();
171   bool has_ptrmap()                  { return _ptrmap_size_in_bits != 0; }
172 
173   bool check_region_crc() 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   int     _narrow_klass_shift;                    // save narrow klass base and shift
193   bool    _compressed_oops;                       // save the flag UseCompressedOops
194   bool    _compressed_class_ptrs;                 // save the flag UseCompressedClassPointers
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   address _heap_begin;                            // heap begin at dump time.
198   address _heap_end;                              // heap end at dump time.
199   bool _has_non_jar_in_classpath;                 // non-jar file entry exists in classpath
200   unsigned int _common_app_classpath_prefix_size; // size of the common prefix of app class paths
201                                                   //    0 if no common prefix exists
202 
203   // The following fields are all sanity checks for whether this archive
204   // will function correctly with this JVM and the bootclasspath it's
205   // invoked with.
206   char  _jvm_ident[JVM_IDENT_MAX];  // identifier string of the jvm that created this dump
207 
208   // The following is a table of all the boot/app/module path entries that were used
209   // during dumping. At run time, we validate these entries according to their
210   // SharedClassPathEntry::_type. See:
211   //      check_nonempty_dir_in_shared_path_table()
212   //      validate_shared_path_table()
213   //      validate_non_existent_class_paths()
214   size_t _shared_path_table_offset;
215 
216   jshort _app_class_paths_start_index;  // Index of first app classpath entry
217   jshort _app_module_paths_start_index; // Index of first module path entry
218   jshort _num_module_paths;             // number of module path entries
219   jshort _max_used_path_index;          // max path index referenced during CDS dump
220   bool   _verify_local;                 // BytecodeVerificationLocal setting
221   bool   _verify_remote;                // BytecodeVerificationRemote setting
222   bool   _has_platform_or_app_classes;  // Archive contains app classes
223   char*  _requested_base_address;       // Archive relocation is not necessary if we map with this base address.
224   char*  _mapped_base_address;          // Actual base address where archive is mapped.
225 
226   bool   _allow_archiving_with_java_agent; // setting of the AllowArchivingWithJavaAgent option
227   bool   _use_optimized_module_handling;// No module-relation VM options were specified, so we can skip
228                                         // some expensive operations.
229   bool   _use_full_module_graph;        // Can we use the full archived module graph?
230   size_t _ptrmap_size_in_bits;          // Size of pointer relocation bitmap
231   char* from_mapped_offset(size_t offset) const {
232     return mapped_base_address() + offset;
233   }
234   void set_as_offset(char* p, size_t *offset);
235 public:
236   // Accessors -- fields declared in GenericCDSFileMapHeader
237   unsigned int magic()                            const { return _generic_header._magic;                    }
238   int crc()                                       const { return _generic_header._crc;                      }
239   int version()                                   const { return _generic_header._version;                  }
240   unsigned int header_size()                      const { return _generic_header._header_size;              }
241   unsigned int base_archive_name_offset()         const { return _generic_header._base_archive_name_offset; }
242   unsigned int base_archive_name_size()           const { return _generic_header._base_archive_name_size;   }
243   unsigned int common_app_classpath_prefix_size() const { return _common_app_classpath_prefix_size;         }
244 
245   void set_magic(unsigned int m)                            { _generic_header._magic = m;                    }
246   void set_crc(int crc_value)                               { _generic_header._crc = crc_value;              }
247   void set_version(int v)                                   { _generic_header._version = v;                  }
248   void set_header_size(unsigned int s)                      { _generic_header._header_size = s;              }
249   void set_base_archive_name_offset(unsigned int s)         { _generic_header._base_archive_name_offset = s; }
250   void set_base_archive_name_size(unsigned int s)           { _generic_header._base_archive_name_size = s;   }
251   void set_common_app_classpath_prefix_size(unsigned int s) { _common_app_classpath_prefix_size = s;         }
252 
253   size_t core_region_alignment()           const { return _core_region_alignment; }
254   int obj_alignment()                      const { return _obj_alignment; }
255   address narrow_oop_base()                const { return _narrow_oop_base; }
256   int narrow_oop_shift()                   const { return _narrow_oop_shift; }
257   bool compact_strings()                   const { return _compact_strings; }
258   uintx max_heap_size()                    const { return _max_heap_size; }
259   CompressedOops::Mode narrow_oop_mode()   const { return _narrow_oop_mode; }
260   int narrow_klass_shift()                 const { return _narrow_klass_shift; }
261   address narrow_klass_base()              const { return (address)mapped_base_address(); }
262   char* cloned_vtables()                   const { return from_mapped_offset(_cloned_vtables_offset); }
263   char* serialized_data()                  const { return from_mapped_offset(_serialized_data_offset); }
264   address heap_begin()                     const { return _heap_begin; }
265   address heap_end()                       const { return _heap_end; }
266   const char* jvm_ident()                  const { return _jvm_ident; }
267   char* requested_base_address()           const { return _requested_base_address; }
268   char* mapped_base_address()              const { return _mapped_base_address; }
269   bool has_platform_or_app_classes()       const { return _has_platform_or_app_classes; }
270   bool has_non_jar_in_classpath()          const { return _has_non_jar_in_classpath; }
271   size_t ptrmap_size_in_bits()             const { return _ptrmap_size_in_bits; }
272   bool compressed_oops()                   const { return _compressed_oops; }
273   bool compressed_class_pointers()         const { return _compressed_class_ptrs; }
274   // FIXME: These should really return int
275   jshort max_used_path_index()             const { return _max_used_path_index; }
276   jshort app_module_paths_start_index()    const { return _app_module_paths_start_index; }
277   jshort app_class_paths_start_index()     const { return _app_class_paths_start_index; }
278   jshort num_module_paths()                const { return _num_module_paths; }
279 
280   void set_has_platform_or_app_classes(bool v)   { _has_platform_or_app_classes = v; }
281   void set_cloned_vtables(char* p)               { set_as_offset(p, &_cloned_vtables_offset); }
282   void set_serialized_data(char* p)              { set_as_offset(p, &_serialized_data_offset); }
283   void set_ptrmap_size_in_bits(size_t s)         { _ptrmap_size_in_bits = s; }
284   void set_mapped_base_address(char* p)          { _mapped_base_address = p; }
285   void copy_base_archive_name(const char* name);
286 
287   void set_shared_path_table(SharedPathTable table) {
288     set_as_offset((char*)table.table(), &_shared_path_table_offset);
289   }
290 
291   void set_requested_base(char* b) {
292     _requested_base_address = b;
293     _mapped_base_address = 0;
294   }
295 
296   SharedPathTable shared_path_table() const {
297     return SharedPathTable((Array<SharedClassPathEntry*>*)
298                            from_mapped_offset(_shared_path_table_offset));
299   }
300 
301   bool validate();
302   int compute_crc();
303 
304   FileMapRegion* region_at(int i) {
305     assert(is_valid_region(i), "invalid region");
306     return FileMapRegion::cast(&_regions[i]);
307   }
308 
309   void populate(FileMapInfo *info, size_t core_region_alignment, size_t header_size,
310                 size_t base_archive_name_size, size_t base_archive_name_offset,
311                 size_t common_app_classpath_size);
312   static bool is_valid_region(int region) {
313     return (0 <= region && region < NUM_CDS_REGIONS);
314   }
315 
316   void print(outputStream* st);
317 };
318 
319 class FileMapInfo : public CHeapObj<mtInternal> {
320 private:
321   friend class ManifestStream;
322   friend class VMStructs;
323   friend class ArchiveBuilder;
324   friend class CDSOffsets;
325   friend class FileMapHeader;
326 
327   bool           _is_static;
328   bool           _file_open;
329   bool           _is_mapped;
330   int            _fd;
331   size_t         _file_offset;
332   const char*    _full_path;
333   const char*    _base_archive_name;
334   FileMapHeader* _header;
335 
336   static SharedPathTable       _shared_path_table;
337   static bool                  _validating_shared_path_table;
338 
339   // FileMapHeader describes the shared space data in the file to be
340   // mapped.  This structure gets written to a file.  It is not a class, so
341   // that the compilers don't add any compiler-private data to it.
342 
343   static FileMapInfo* _current_info;
344   static FileMapInfo* _dynamic_archive_info;
345   static bool _heap_pointers_need_patching;
346   static bool _memory_mapping_failed;
347   static GrowableArray<const char*>* _non_existent_class_paths;
348 
349 public:
350   FileMapHeader *header() const       { return _header; }
351   static bool get_base_archive_name_from_header(const char* archive_name,
352                                                 char** base_archive_name);
353   static SharedPathTable shared_path_table() {
354     return _shared_path_table;
355   }
356 
357   bool init_from_file(int fd);
358   static void metaspace_pointers_do(MetaspaceClosure* it) {
359     _shared_path_table.metaspace_pointers_do(it);
360   }
361 
362   void log_paths(const char* msg, int start_idx, int end_idx);
363 
364   FileMapInfo(const char* full_apth, bool is_static);
365   ~FileMapInfo();
366 
367   // Accessors
368   int    compute_header_crc()  const { return header()->compute_crc(); }
369   void   set_header_crc(int crc)     { header()->set_crc(crc); }
370   int    region_crc(int i)     const { return region_at(i)->crc(); }
371   void   populate_header(size_t core_region_alignment);
372   bool   validate_header();
373   void   invalidate();
374   int    crc()                 const { return header()->crc(); }
375   int    version()             const { return header()->version(); }
376   unsigned int magic()         const { return header()->magic(); }
377   address narrow_oop_base()    const { return header()->narrow_oop_base(); }
378   int     narrow_oop_shift()   const { return header()->narrow_oop_shift(); }
379   uintx   max_heap_size()      const { return header()->max_heap_size(); }
380   address narrow_klass_base()  const { return header()->narrow_klass_base(); }
381   int     narrow_klass_shift() const { return header()->narrow_klass_shift(); }
382   size_t  core_region_alignment() const { return header()->core_region_alignment(); }
383 
384   CompressedOops::Mode narrow_oop_mode()      const { return header()->narrow_oop_mode(); }
385   jshort app_module_paths_start_index()       const { return header()->app_module_paths_start_index(); }
386   jshort app_class_paths_start_index()        const { return header()->app_class_paths_start_index(); }
387 
388   char* cloned_vtables()                      const { return header()->cloned_vtables(); }
389   void  set_cloned_vtables(char* p)           const { header()->set_cloned_vtables(p); }
390   char* serialized_data()                     const { return header()->serialized_data(); }
391   void  set_serialized_data(char* p)          const { header()->set_serialized_data(p); }
392 
393   bool  is_file_position_aligned() const;
394   void  align_file_position();
395 
396   bool is_static()                            const { return _is_static; }
397   bool is_mapped()                            const { return _is_mapped; }
398   void set_is_mapped(bool v)                        { _is_mapped = v; }
399   const char* full_path()                     const { return _full_path; }
400 
401   void set_requested_base(char* b)                  { header()->set_requested_base(b); }
402   char* requested_base_address()           const    { return header()->requested_base_address(); }
403 
404   class DynamicArchiveHeader* dynamic_header() const {
405     assert(!is_static(), "must be");
406     return (DynamicArchiveHeader*)header();
407   }
408 
409   void set_has_platform_or_app_classes(bool v) {
410     header()->set_has_platform_or_app_classes(v);
411   }
412   bool has_platform_or_app_classes() const {
413     return header()->has_platform_or_app_classes();
414   }
415 
416   static FileMapInfo* current_info() {
417     CDS_ONLY(return _current_info;)
418     NOT_CDS(return nullptr;)
419   }
420 
421   static void set_current_info(FileMapInfo* info) {
422     CDS_ONLY(_current_info = info;)
423   }
424 
425   static FileMapInfo* dynamic_info() {
426     CDS_ONLY(return _dynamic_archive_info;)
427     NOT_CDS(return nullptr;)
428   }
429 
430   static void assert_mark(bool check);
431 
432   // File manipulation.
433   bool  initialize() NOT_CDS_RETURN_(false);
434   bool  open_for_read();
435   void  open_for_write();
436   void  write_header();
437   void  write_region(int region, char* base, size_t size,
438                      bool read_only, bool allow_exec);
439   char* write_bitmap_region(const CHeapBitMap* ptrmap, ArchiveHeapInfo* heap_info,
440                             size_t &size_in_bytes);
441   size_t write_heap_region(ArchiveHeapInfo* heap_info);
442   void  write_bytes(const void* buffer, size_t count);
443   void  write_bytes_aligned(const void* buffer, size_t count);
444   size_t  read_bytes(void* buffer, size_t count);
445   static size_t readonly_total();
446   MapArchiveResult map_regions(int regions[], int num_regions, char* mapped_base_address, ReservedSpace rs);
447   void  unmap_regions(int regions[], int num_regions);
448   void  map_or_load_heap_region() NOT_CDS_JAVA_HEAP_RETURN;
449   void  fixup_mapped_heap_region() NOT_CDS_JAVA_HEAP_RETURN;
450   void  patch_heap_embedded_pointers() NOT_CDS_JAVA_HEAP_RETURN;
451   bool  has_heap_region()  NOT_CDS_JAVA_HEAP_RETURN_(false);
452   MemRegion get_heap_region_requested_range() NOT_CDS_JAVA_HEAP_RETURN_(MemRegion());
453   bool  read_region(int i, char* base, size_t size, bool do_commit);
454   char* map_bitmap_region();
455   void  unmap_region(int i);
456   void  close();
457   bool  is_open() { return _file_open; }
458   ReservedSpace reserve_shared_memory();
459 
460   // JVM/TI RedefineClasses() support:
461   // Remap the shared readonly space to shared readwrite, private.
462   bool  remap_shared_readonly_as_readwrite();
463 
464   static bool memory_mapping_failed() {
465     CDS_ONLY(return _memory_mapping_failed;)
466     NOT_CDS(return false;)
467   }
468 
469   static void allocate_shared_path_table(TRAPS);
470   static int add_shared_classpaths(int i, const char* which, ClassPathEntry *cpe, TRAPS);
471   static void check_nonempty_dir_in_shared_path_table();
472   bool check_module_paths();
473   bool validate_shared_path_table();
474   void validate_non_existent_class_paths();
475   static void set_shared_path_table(FileMapInfo* info) {
476     _shared_path_table = info->header()->shared_path_table();
477   }
478   static void update_jar_manifest(ClassPathEntry *cpe, SharedClassPathEntry* ent, TRAPS);
479   static int num_non_existent_class_paths();
480   static void record_non_existent_class_path_entry(const char* path);
481 
482 #if INCLUDE_JVMTI
483   // Caller needs a ResourceMark because parts of the returned cfs are resource-allocated.
484   static ClassFileStream* open_stream_for_jvmti(InstanceKlass* ik, Handle class_loader, TRAPS);
485 #endif
486 
487   static SharedClassPathEntry* shared_path(int index) {
488     return _shared_path_table.path_at(index);
489   }
490 
491   static const char* shared_path_name(int index) {
492     assert(index >= 0, "Sanity");
493     return shared_path(index)->name();
494   }
495 
496   static int get_number_of_shared_paths() {
497     return _shared_path_table.size();
498   }
499 
500   static int get_module_shared_path_index(Symbol* location) NOT_CDS_RETURN_(-1);
501 
502   // The offset of the first core region in the archive, relative to SharedBaseAddress
503   size_t mapping_base_offset() const { return first_core_region()->mapping_offset();    }
504   // The offset of the (exclusive) end of the last core region in this archive, relative to SharedBaseAddress
505   size_t mapping_end_offset()  const { return last_core_region()->mapping_end_offset(); }
506 
507   char* mapped_base()    const { return first_core_region()->mapped_base(); }
508   char* mapped_end()     const { return last_core_region()->mapped_end();   }
509 
510   // Non-zero if the archive needs to be mapped a non-default location due to ASLR.
511   intx relocation_delta() const {
512     return header()->mapped_base_address() - header()->requested_base_address();
513   }
514 
515   FileMapRegion* first_core_region() const;
516   FileMapRegion* last_core_region()  const;
517 
518   FileMapRegion* region_at(int i) const {
519     return header()->region_at(i);
520   }
521 
522   void print(outputStream* st) const;
523 
524   const char* vm_version() {
525     return header()->jvm_ident();
526   }
527 
528  private:
529   void  seek_to_position(size_t pos);
530   char* skip_first_path_entry(const char* path) NOT_CDS_RETURN_(nullptr);
531   int   num_paths(const char* path) NOT_CDS_RETURN_(0);
532   bool  check_paths_existence(const char* paths) NOT_CDS_RETURN_(false);
533   GrowableArray<const char*>* create_dumptime_app_classpath_array() NOT_CDS_RETURN_(nullptr);
534   GrowableArray<const char*>* create_path_array(const char* path) NOT_CDS_RETURN_(nullptr);
535   bool  classpath_failure(const char* msg, const char* name) NOT_CDS_RETURN_(false);
536   unsigned int longest_common_app_classpath_prefix_len(int num_paths,
537                                                        GrowableArray<const char*>* rp_array)
538                                                        NOT_CDS_RETURN_(0);
539   bool  check_paths(int shared_path_start_idx, int num_paths,
540                     GrowableArray<const char*>* rp_array,
541                     unsigned int dumptime_prefix_len,
542                     unsigned int runtime_prefix_len) NOT_CDS_RETURN_(false);
543   bool  validate_boot_class_paths() NOT_CDS_RETURN_(false);
544   bool  validate_app_class_paths(int shared_app_paths_len) NOT_CDS_RETURN_(false);
545   bool  map_heap_region_impl() NOT_CDS_JAVA_HEAP_RETURN_(false);
546   void  dealloc_heap_region() NOT_CDS_JAVA_HEAP_RETURN;
547   bool  can_use_heap_region();
548   bool  load_heap_region() NOT_CDS_JAVA_HEAP_RETURN_(false);
549   bool  map_heap_region() NOT_CDS_JAVA_HEAP_RETURN_(false);
550   void  init_heap_region_relocation();
551   MapArchiveResult map_region(int i, intx addr_delta, char* mapped_base_address, ReservedSpace rs);
552   bool  relocate_pointers_in_core_regions(intx addr_delta);
553 
554   static MemRegion _mapped_heap_memregion;
555 
556 public:
557   address heap_region_dumptime_address() NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
558   address heap_region_requested_address() NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
559   address heap_region_mapped_address() NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
560   narrowOop encoded_heap_region_dumptime_address();
561 
562 private:
563 
564 #if INCLUDE_JVMTI
565   static ClassPathEntry** _classpath_entries_for_jvmti;
566   static ClassPathEntry* get_classpath_entry_for_jvmti(int i, TRAPS);
567 #endif
568 };
569 
570 #endif // SHARE_CDS_FILEMAP_HPP