1 /* 2 * Copyright (c) 2003, 2018, 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_VM_MEMORY_FILEMAP_HPP 26 #define SHARE_VM_MEMORY_FILEMAP_HPP 27 28 #include "classfile/classLoader.hpp" 29 #include "memory/metaspaceShared.hpp" 30 #include "memory/metaspace.hpp" 31 #include "memory/universe.hpp" 32 #include "utilities/align.hpp" 33 34 // Layout of the file: 35 // header: dump of archive instance plus versioning info, datestamp, etc. 36 // [magic # = 0xF00BABA2] 37 // ... padding to align on page-boundary 38 // read-write space 39 // read-only space 40 // misc data (block offset table, string table, symbols, dictionary, etc.) 41 // tag(666) 42 43 static const int JVM_IDENT_MAX = 256; 44 45 class SharedClassPathEntry { 46 enum { 47 modules_image_entry, 48 jar_entry, 49 signed_jar_entry, 50 dir_entry, 51 unknown_entry 52 }; 53 protected: 54 u1 _type; 55 time_t _timestamp; // jar timestamp, 0 if is directory, modules image or other 56 long _filesize; // jar/jimage file size, -1 if is directory, -2 if other 57 Array<char>* _name; 58 Array<u1>* _manifest; 59 60 public: 61 void init(const char* name, bool is_modules_image, TRAPS); 62 void metaspace_pointers_do(MetaspaceClosure* it); 63 bool validate(bool is_class_path = true); 64 65 // The _timestamp only gets set for jar files. 66 bool has_timestamp() { 67 return _timestamp != 0; 68 } 69 bool is_dir() { return _type == dir_entry; } 70 bool is_modules_image() { return _type == modules_image_entry; } 71 bool is_jar() { return _type == jar_entry; } 72 bool is_signed() { return _type == signed_jar_entry; } 73 void set_is_signed() { 74 _type = signed_jar_entry; 75 } 76 time_t timestamp() const { return _timestamp; } 77 long filesize() const { return _filesize; } 78 const char* name() const { return _name->data(); } 79 const char* manifest() const { 80 return (_manifest == NULL) ? NULL : (const char*)_manifest->data(); 81 } 82 int manifest_size() const { 83 return (_manifest == NULL) ? 0 : _manifest->length(); 84 } 85 void set_manifest(Array<u1>* manifest) { 86 _manifest = manifest; 87 } 88 }; 89 90 class FileMapInfo : public CHeapObj<mtInternal> { 91 private: 92 friend class ManifestStream; 93 friend class VMStructs; 94 enum { 95 _invalid_version = -1, 96 _current_version = 3 97 }; 98 99 bool _file_open; 100 int _fd; 101 size_t _file_offset; 102 103 private: 104 static Array<u8>* _shared_path_table; 105 static int _shared_path_table_size; 106 static size_t _shared_path_entry_size; 107 static bool _validating_shared_path_table; 108 109 // FileMapHeader describes the shared space data in the file to be 110 // mapped. This structure gets written to a file. It is not a class, so 111 // that the compilers don't add any compiler-private data to it. 112 113 public: 114 struct FileMapHeaderBase : public CHeapObj<mtClass> { 115 // Need to put something here. Otherwise, in product build, because CHeapObj has no virtual 116 // methods, we would get sizeof(FileMapHeaderBase) == 1 with gcc. 117 intx _dummy; 118 }; 119 struct FileMapHeader : FileMapHeaderBase { 120 // Use data() and data_size() to memcopy to/from the FileMapHeader. We need to 121 // avoid read/writing the C++ vtable pointer. 122 static size_t data_size() { 123 return sizeof(FileMapHeader) - sizeof(FileMapInfo::FileMapHeaderBase); 124 } 125 char* data() { 126 return ((char*)this) + sizeof(FileMapHeaderBase); 127 } 128 129 int _magic; // identify file type. 130 int _crc; // header crc checksum. 131 int _version; // (from enum, above.) 132 size_t _alignment; // how shared archive should be aligned 133 int _obj_alignment; // value of ObjectAlignmentInBytes 134 address _narrow_oop_base; // compressed oop encoding base 135 int _narrow_oop_shift; // compressed oop encoding shift 136 bool _compact_strings; // value of CompactStrings 137 uintx _max_heap_size; // java max heap size during dumping 138 Universe::NARROW_OOP_MODE _narrow_oop_mode; // compressed oop encoding mode 139 int _narrow_klass_shift; // save narrow klass base and shift 140 address _narrow_klass_base; 141 char* _misc_data_patching_start; 142 char* _read_only_tables_start; 143 address _cds_i2i_entry_code_buffers; 144 size_t _cds_i2i_entry_code_buffers_size; 145 size_t _core_spaces_size; // number of bytes allocated by the core spaces 146 // (mc, md, ro, rw and od). 147 MemRegion _g1_reserved; // reserved region at dump time. 148 struct space_info { 149 int _crc; // crc checksum of the current space 150 size_t _file_offset; // sizeof(this) rounded to vm page size 151 union { 152 char* _base; // copy-on-write base address 153 intx _offset; // offset from the compressed oop encoding base, only used 154 // by archive heap space 155 } _addr; 156 size_t _used; // for setting space top on read 157 bool _read_only; // read only space? 158 bool _allow_exec; // executable code in space? 159 } _space[MetaspaceShared::n_regions]; 160 161 // The following fields are all sanity checks for whether this archive 162 // will function correctly with this JVM and the bootclasspath it's 163 // invoked with. 164 char _jvm_ident[JVM_IDENT_MAX]; // identifier for jvm 165 166 // The _paths_misc_info is a variable-size structure that records "miscellaneous" 167 // information during dumping. It is generated and validated by the 168 // SharedPathsMiscInfo class. See SharedPathsMiscInfo.hpp for 169 // detailed description. 170 // 171 // The _paths_misc_info data is stored as a byte array in the archive file header, 172 // immediately after the _header field. This information is used only when 173 // checking the validity of the archive and is deallocated after the archive is loaded. 174 // 175 // Note that the _paths_misc_info does NOT include information for JAR files 176 // that existed during dump time. Their information is stored in _shared_path_table. 177 int _paths_misc_info_size; 178 179 // The following is a table of all the class path entries that were used 180 // during dumping. At run time, we require these files to exist and have the same 181 // size/modification time, or else the archive will refuse to load. 182 // 183 // All of these entries must be JAR files. The dumping process would fail if a non-empty 184 // directory was specified in the classpaths. If an empty directory was specified 185 // it is checked by the _paths_misc_info as described above. 186 // 187 // FIXME -- if JAR files in the tail of the list were specified but not used during dumping, 188 // they should be removed from this table, to save space and to avoid spurious 189 // loading failures during runtime. 190 int _shared_path_table_size; 191 size_t _shared_path_entry_size; 192 Array<u8>* _shared_path_table; 193 194 jshort _app_class_paths_start_index; // Index of first app classpath entry 195 jshort _app_module_paths_start_index; // Index of first module path entry 196 bool _verify_local; // BytecodeVerificationLocal setting 197 bool _verify_remote; // BytecodeVerificationRemote setting 198 bool _has_platform_or_app_classes; // Archive contains app classes 199 200 void set_has_platform_or_app_classes(bool v) { 201 _has_platform_or_app_classes = v; 202 } 203 bool has_platform_or_app_classes() { return _has_platform_or_app_classes; } 204 205 char* region_addr(int idx); 206 207 bool validate(); 208 void populate(FileMapInfo* info, size_t alignment); 209 int compute_crc(); 210 }; 211 212 FileMapHeader * _header; 213 214 const char* _full_path; 215 char* _paths_misc_info; 216 217 static FileMapInfo* _current_info; 218 static bool _heap_pointers_need_relocation; 219 220 bool init_from_file(int fd); 221 void align_file_position(); 222 bool validate_header_impl(); 223 static void metaspace_pointers_do(MetaspaceClosure* it); 224 225 public: 226 FileMapInfo(); 227 ~FileMapInfo(); 228 229 static int current_version() { return _current_version; } 230 int compute_header_crc() { return _header->compute_crc(); } 231 void set_header_crc(int crc) { _header->_crc = crc; } 232 void populate_header(size_t alignment); 233 bool validate_header(); 234 void invalidate(); 235 int version() { return _header->_version; } 236 size_t alignment() { return _header->_alignment; } 237 Universe::NARROW_OOP_MODE narrow_oop_mode() { return _header->_narrow_oop_mode; } 238 address narrow_oop_base() const { return _header->_narrow_oop_base; } 239 int narrow_oop_shift() const { return _header->_narrow_oop_shift; } 240 uintx max_heap_size() const { return _header->_max_heap_size; } 241 address narrow_klass_base() const { return _header->_narrow_klass_base; } 242 int narrow_klass_shift() const { return _header->_narrow_klass_shift; } 243 struct FileMapHeader* header() { return _header; } 244 char* misc_data_patching_start() { return _header->_misc_data_patching_start; } 245 void set_misc_data_patching_start(char* p) { _header->_misc_data_patching_start = p; } 246 char* read_only_tables_start() { return _header->_read_only_tables_start; } 247 void set_read_only_tables_start(char* p) { _header->_read_only_tables_start = p; } 248 249 address cds_i2i_entry_code_buffers() { 250 return _header->_cds_i2i_entry_code_buffers; 251 } 252 void set_cds_i2i_entry_code_buffers(address addr) { 253 _header->_cds_i2i_entry_code_buffers = addr; 254 } 255 size_t cds_i2i_entry_code_buffers_size() { 256 return _header->_cds_i2i_entry_code_buffers_size; 257 } 258 void set_cds_i2i_entry_code_buffers_size(size_t s) { 259 _header->_cds_i2i_entry_code_buffers_size = s; 260 } 261 void set_core_spaces_size(size_t s) { _header->_core_spaces_size = s; } 262 size_t core_spaces_size() { return _header->_core_spaces_size; } 263 264 static FileMapInfo* current_info() { 265 CDS_ONLY(return _current_info;) 266 NOT_CDS(return NULL;) 267 } 268 269 static void assert_mark(bool check); 270 271 // File manipulation. 272 bool initialize() NOT_CDS_RETURN_(false); 273 bool open_for_read(); 274 void open_for_write(); 275 void write_header(); 276 void write_region(int region, char* base, size_t size, 277 bool read_only, bool allow_exec); 278 size_t write_archive_heap_regions(GrowableArray<MemRegion> *heap_mem, 279 int first_region_id, int max_num_regions); 280 void write_bytes(const void* buffer, int count); 281 void write_bytes_aligned(const void* buffer, int count); 282 char* map_region(int i, char** top_ret); 283 void map_heap_regions_impl() NOT_CDS_JAVA_HEAP_RETURN; 284 void map_heap_regions() NOT_CDS_JAVA_HEAP_RETURN; 285 void fixup_mapped_heap_regions() NOT_CDS_JAVA_HEAP_RETURN; 286 void relocate_archived_heap_embedded_pointers() NOT_CDS_JAVA_HEAP_RETURN; 287 void relocate_archived_heap_embedded_pointers_impl(MemRegion *heap_mem, int num) NOT_CDS_JAVA_HEAP_RETURN; 288 bool has_heap_regions() NOT_CDS_JAVA_HEAP_RETURN; 289 void unmap_region(int i); 290 bool verify_region_checksum(int i); 291 void close(); 292 bool is_open() { return _file_open; } 293 ReservedSpace reserve_shared_memory(); 294 295 // JVM/TI RedefineClasses() support: 296 // Remap the shared readonly space to shared readwrite, private. 297 bool remap_shared_readonly_as_readwrite(); 298 299 // Errors. 300 static void fail_stop(const char *msg, ...) ATTRIBUTE_PRINTF(1, 2); 301 static void fail_continue(const char *msg, ...) ATTRIBUTE_PRINTF(1, 2); 302 303 bool is_in_shared_region(const void* p, int idx) NOT_CDS_RETURN_(false); 304 void print_shared_spaces() NOT_CDS_RETURN; 305 306 // Stop CDS sharing and unmap CDS regions. 307 static void stop_sharing_and_unmap(const char* msg); 308 309 static void allocate_shared_path_table(); 310 static void check_nonempty_dir_in_shared_path_table(); 311 bool validate_shared_path_table(); 312 static void update_shared_classpath(ClassPathEntry *cpe, SharedClassPathEntry* ent, TRAPS); 313 314 static SharedClassPathEntry* shared_path(int index) { 315 if (index < 0) { 316 return NULL; 317 } 318 assert(index < _shared_path_table_size, "sanity"); 319 char* p = (char*)_shared_path_table->data(); 320 p += _shared_path_entry_size * index; 321 return (SharedClassPathEntry*)p; 322 } 323 324 static const char* shared_path_name(int index) { 325 assert(index >= 0, "Sanity"); 326 return shared_path(index)->name(); 327 } 328 329 static int get_number_of_shared_paths() { 330 return _shared_path_table_size; 331 } 332 333 private: 334 bool map_heap_data(MemRegion **heap_mem, int first, int max, int* num, 335 bool is_open = false) NOT_CDS_JAVA_HEAP_RETURN_(false); 336 bool verify_mapped_heap_regions(int first, int num) NOT_CDS_JAVA_HEAP_RETURN_(false); 337 void dealloc_archive_heap_regions(MemRegion* regions, int num) NOT_CDS_JAVA_HEAP_RETURN; 338 }; 339 340 #endif // SHARE_VM_MEMORY_FILEMAP_HPP