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