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