1 /* 2 * Copyright (c) 2012, 2020, 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_MEMORY_METASPACESHARED_HPP 26 #define SHARE_MEMORY_METASPACESHARED_HPP 27 28 #include "classfile/compactHashtable.hpp" 29 #include "memory/allocation.hpp" 30 #include "memory/memRegion.hpp" 31 #include "memory/virtualspace.hpp" 32 #include "oops/oop.hpp" 33 #include "utilities/macros.hpp" 34 #include "utilities/resourceHash.hpp" 35 36 #define MAX_SHARED_DELTA (0x7FFFFFFF) 37 38 class outputStream; 39 class FileMapInfo; 40 class CHeapBitMap; 41 struct ArchiveHeapOopmapInfo; 42 43 enum MapArchiveResult { 44 MAP_ARCHIVE_SUCCESS, 45 MAP_ARCHIVE_MMAP_FAILURE, 46 MAP_ARCHIVE_OTHER_FAILURE 47 }; 48 49 class MetaspaceSharedStats { 50 public: 51 MetaspaceSharedStats() { 52 memset(this, 0, sizeof(*this)); 53 } 54 CompactHashtableStats symbol; 55 CompactHashtableStats string; 56 }; 57 58 #if INCLUDE_CDS 59 class DumpRegion { 60 private: 61 const char* _name; 62 char* _base; 63 char* _top; 64 char* _end; 65 bool _is_packed; 66 ReservedSpace* _rs; 67 VirtualSpace* _vs; 68 69 public: 70 DumpRegion(const char* name) : _name(name), _base(NULL), _top(NULL), _end(NULL), _is_packed(false) {} 71 72 char* expand_top_to(char* newtop); 73 char* allocate(size_t num_bytes, size_t alignment=BytesPerWord); 74 75 void append_intptr_t(intptr_t n, bool need_to_mark = false); 76 77 char* base() const { return _base; } 78 char* top() const { return _top; } 79 char* end() const { return _end; } 80 size_t reserved() const { return _end - _base; } 81 size_t used() const { return _top - _base; } 82 bool is_packed() const { return _is_packed; } 83 bool is_allocatable() const { 84 return !is_packed() && _base != NULL; 85 } 86 87 void print(size_t total_bytes) const; 88 void print_out_of_space_msg(const char* failing_region, size_t needed_bytes); 89 90 void init(ReservedSpace* rs, VirtualSpace* vs); 91 92 void pack(DumpRegion* next = NULL); 93 94 bool contains(char* p) { 95 return base() <= p && p < top(); 96 } 97 }; 98 99 // Closure for serializing initialization data out to a data area to be 100 // written to the shared file. 101 102 class WriteClosure : public SerializeClosure { 103 private: 104 DumpRegion* _dump_region; 105 106 public: 107 WriteClosure(DumpRegion* r) { 108 _dump_region = r; 109 } 110 111 void do_ptr(void** p) { 112 _dump_region->append_intptr_t((intptr_t)*p, true); 113 } 114 115 void do_u4(u4* p) { 116 _dump_region->append_intptr_t((intptr_t)(*p)); 117 } 118 119 void do_bool(bool *p) { 120 _dump_region->append_intptr_t((intptr_t)(*p)); 121 } 122 123 void do_tag(int tag) { 124 _dump_region->append_intptr_t((intptr_t)tag); 125 } 126 127 void do_oop(oop* o); 128 129 void do_region(u_char* start, size_t size); 130 131 bool reading() const { return false; } 132 }; 133 134 // Closure for serializing initialization data in from a data area 135 // (ptr_array) read from the shared file. 136 137 class ReadClosure : public SerializeClosure { 138 private: 139 intptr_t** _ptr_array; 140 141 inline intptr_t nextPtr() { 142 return *(*_ptr_array)++; 143 } 144 145 public: 146 ReadClosure(intptr_t** ptr_array) { _ptr_array = ptr_array; } 147 148 void do_ptr(void** p); 149 150 void do_u4(u4* p); 151 152 void do_bool(bool *p); 153 154 void do_tag(int tag); 155 156 void do_oop(oop *p); 157 158 void do_region(u_char* start, size_t size); 159 160 bool reading() const { return true; } 161 }; 162 163 #endif // INCLUDE_CDS 164 165 // Class Data Sharing Support 166 class MetaspaceShared : AllStatic { 167 168 // CDS support 169 170 // Note: _shared_rs and _symbol_rs are only used at dump time. 171 static ReservedSpace _shared_rs; 172 static VirtualSpace _shared_vs; 173 static ReservedSpace _symbol_rs; 174 static VirtualSpace _symbol_vs; 175 static int _max_alignment; 176 static MetaspaceSharedStats _stats; 177 static bool _has_error_classes; 178 static bool _archive_loading_failed; 179 static bool _remapped_readwrite; 180 static address _i2i_entry_code_buffers; 181 static size_t _i2i_entry_code_buffers_size; 182 static size_t _core_spaces_size; 183 static void* _shared_metaspace_static_top; 184 static intx _relocation_delta; 185 static char* _requested_base_address; 186 static bool _use_optimized_module_handling; 187 public: 188 enum { 189 // core archive spaces 190 mc = 0, // miscellaneous code for method trampolines 191 rw = 1, // read-write shared space in the heap 192 ro = 2, // read-only shared space in the heap 193 bm = 3, // relocation bitmaps (freed after file mapping is finished) 194 num_core_region = 3, 195 num_non_heap_spaces = 4, 196 197 // mapped java heap regions 198 first_closed_archive_heap_region = bm + 1, 199 max_closed_archive_heap_region = 2, 200 last_closed_archive_heap_region = first_closed_archive_heap_region + max_closed_archive_heap_region - 1, 201 first_open_archive_heap_region = last_closed_archive_heap_region + 1, 202 max_open_archive_heap_region = 2, 203 last_open_archive_heap_region = first_open_archive_heap_region + max_open_archive_heap_region - 1, 204 205 last_valid_region = last_open_archive_heap_region, 206 n_regions = last_valid_region + 1 // total number of regions 207 }; 208 209 static void prepare_for_dumping() NOT_CDS_RETURN; 210 static void preload_and_dump(TRAPS) NOT_CDS_RETURN; 211 static int preload_classes(const char * class_list_path, 212 TRAPS) NOT_CDS_RETURN_(0); 213 214 static GrowableArray<Klass*>* collected_klasses(); 215 216 static ReservedSpace* shared_rs() { 217 CDS_ONLY(return &_shared_rs); 218 NOT_CDS(return NULL); 219 } 220 221 static Symbol* symbol_rs_base() { 222 return (Symbol*)_symbol_rs.base(); 223 } 224 225 static void set_shared_rs(ReservedSpace rs) { 226 CDS_ONLY(_shared_rs = rs); 227 } 228 229 static void commit_to(ReservedSpace* rs, VirtualSpace* vs, char* newtop) NOT_CDS_RETURN; 230 static void initialize_dumptime_shared_and_meta_spaces() NOT_CDS_RETURN; 231 static void initialize_runtime_shared_and_meta_spaces() NOT_CDS_RETURN; 232 static void post_initialize(TRAPS) NOT_CDS_RETURN; 233 234 static void print_on(outputStream* st); 235 236 // Delta of this object from SharedBaseAddress 237 static uintx object_delta_uintx(void* obj); 238 239 static u4 object_delta_u4(void* obj) { 240 // offset is guaranteed to be less than MAX_SHARED_DELTA in DumpRegion::expand_top_to() 241 uintx deltax = object_delta_uintx(obj); 242 guarantee(deltax <= MAX_SHARED_DELTA, "must be 32-bit offset"); 243 return (u4)deltax; 244 } 245 246 static void set_archive_loading_failed() { 247 _archive_loading_failed = true; 248 } 249 static bool is_in_output_space(void* ptr) { 250 assert(DumpSharedSpaces, "must be"); 251 return shared_rs()->contains(ptr); 252 } 253 254 static bool map_shared_spaces(FileMapInfo* mapinfo) NOT_CDS_RETURN_(false); 255 static void initialize_shared_spaces() NOT_CDS_RETURN; 256 257 // Return true if given address is in the shared metaspace regions (i.e., excluding any 258 // mapped shared heap regions.) 259 static bool is_in_shared_metaspace(const void* p) { 260 return MetaspaceObj::is_shared((const MetaspaceObj*)p); 261 } 262 263 static address shared_metaspace_top() { 264 return (address)MetaspaceObj::shared_metaspace_top(); 265 } 266 267 static void set_shared_metaspace_range(void* base, void *static_top, void* top) NOT_CDS_RETURN; 268 269 // Return true if given address is in the shared region corresponding to the idx 270 static bool is_in_shared_region(const void* p, int idx) NOT_CDS_RETURN_(false); 271 272 static bool is_in_trampoline_frame(address addr) NOT_CDS_RETURN_(false); 273 274 static bool is_shared_dynamic(void* p) NOT_CDS_RETURN_(false); 275 276 static char* allocate_cpp_vtable_clones(); 277 static void clone_cpp_vtables(intptr_t* p); 278 static void zero_cpp_vtable_clones_for_writing(); 279 static void patch_cpp_vtable_pointers(); 280 static void serialize_cloned_cpp_vtptrs(SerializeClosure* sc); 281 282 static bool is_valid_shared_method(const Method* m) NOT_CDS_RETURN_(false); 283 static void serialize(SerializeClosure* sc) NOT_CDS_RETURN; 284 285 static MetaspaceSharedStats* stats() { 286 return &_stats; 287 } 288 289 static void report_out_of_space(const char* name, size_t needed_bytes); 290 291 // JVM/TI RedefineClasses() support: 292 // Remap the shared readonly space to shared readwrite, private if 293 // sharing is enabled. Simply returns true if sharing is not enabled 294 // or if the remapping has already been done by a prior call. 295 static bool remap_shared_readonly_as_readwrite() NOT_CDS_RETURN_(true); 296 static bool remapped_readwrite() { 297 CDS_ONLY(return _remapped_readwrite); 298 NOT_CDS(return false); 299 } 300 301 static bool try_link_class(InstanceKlass* ik, TRAPS); 302 static void link_and_cleanup_shared_classes(TRAPS) NOT_CDS_RETURN; 303 304 #if INCLUDE_CDS 305 static size_t reserved_space_alignment(); 306 static void init_shared_dump_space(DumpRegion* first_space); 307 static DumpRegion* misc_code_dump_space(); 308 static DumpRegion* read_write_dump_space(); 309 static DumpRegion* read_only_dump_space(); 310 static void pack_dump_space(DumpRegion* current, DumpRegion* next, 311 ReservedSpace* rs); 312 313 static void rewrite_nofast_bytecodes_and_calculate_fingerprints(Thread* thread, InstanceKlass* ik); 314 #endif 315 316 // Allocate a block of memory from the temporary "symbol" region. 317 static char* symbol_space_alloc(size_t num_bytes); 318 319 // Allocate a block of memory from the "mc" or "ro" regions. 320 static char* misc_code_space_alloc(size_t num_bytes); 321 static char* read_only_space_alloc(size_t num_bytes); 322 323 template <typename T> 324 static Array<T>* new_ro_array(int length) { 325 #if INCLUDE_CDS 326 size_t byte_size = Array<T>::byte_sizeof(length, sizeof(T)); 327 Array<T>* array = (Array<T>*)read_only_space_alloc(byte_size); 328 array->initialize(length); 329 return array; 330 #else 331 return NULL; 332 #endif 333 } 334 335 template <typename T> 336 static size_t ro_array_bytesize(int length) { 337 size_t byte_size = Array<T>::byte_sizeof(length, sizeof(T)); 338 return align_up(byte_size, BytesPerWord); 339 } 340 341 static address i2i_entry_code_buffers(size_t total_size); 342 343 static address i2i_entry_code_buffers() { 344 return _i2i_entry_code_buffers; 345 } 346 static size_t i2i_entry_code_buffers_size() { 347 return _i2i_entry_code_buffers_size; 348 } 349 static void relocate_klass_ptr(oop o); 350 351 static Klass* get_relocated_klass(Klass *k, bool is_final=false); 352 353 static void allocate_cloned_cpp_vtptrs(); 354 static intptr_t* get_archived_cpp_vtable(MetaspaceObj::Type msotype, address obj); 355 static void initialize_ptr_marker(CHeapBitMap* ptrmap); 356 357 // This is the base address as specified by -XX:SharedBaseAddress during -Xshare:dump. 358 // Both the base/top archives are written using this as their base address. 359 static char* requested_base_address() { 360 return _requested_base_address; 361 } 362 363 // Non-zero if the archive(s) need to be mapped a non-default location due to ASLR. 364 static intx relocation_delta() { return _relocation_delta; } 365 static intx final_delta(); 366 static bool use_windows_memory_mapping() { 367 const bool is_windows = (NOT_WINDOWS(false) WINDOWS_ONLY(true)); 368 //const bool is_windows = true; // enable this to allow testing the windows mmap semantics on Linux, etc. 369 return is_windows; 370 } 371 372 static void write_core_archive_regions(FileMapInfo* mapinfo, 373 GrowableArray<ArchiveHeapOopmapInfo>* closed_oopmaps, 374 GrowableArray<ArchiveHeapOopmapInfo>* open_oopmaps); 375 376 // Can we skip some expensive operations related to modules? 377 static bool use_optimized_module_handling() { return _use_optimized_module_handling; } 378 static void disable_optimized_module_handling() { _use_optimized_module_handling = false; } 379 380 private: 381 #if INCLUDE_CDS 382 static void write_region(FileMapInfo* mapinfo, int region_idx, DumpRegion* dump_region, 383 bool read_only, bool allow_exec); 384 #endif 385 static void read_extra_data(const char* filename, TRAPS) NOT_CDS_RETURN; 386 static FileMapInfo* open_static_archive(); 387 static FileMapInfo* open_dynamic_archive(); 388 // use_requested_addr: If true (default), attempt to map at the address the 389 static MapArchiveResult map_archives(FileMapInfo* static_mapinfo, FileMapInfo* dynamic_mapinfo, 390 bool use_requested_addr); 391 static char* reserve_address_space_for_archives(FileMapInfo* static_mapinfo, 392 FileMapInfo* dynamic_mapinfo, 393 bool use_archive_base_addr, 394 ReservedSpace& archive_space_rs, 395 ReservedSpace& class_space_rs); 396 static void release_reserved_spaces(ReservedSpace& archive_space_rs, 397 ReservedSpace& class_space_rs); 398 static MapArchiveResult map_archive(FileMapInfo* mapinfo, char* mapped_base_address, ReservedSpace rs); 399 static void unmap_archive(FileMapInfo* mapinfo); 400 }; 401 #endif // SHARE_MEMORY_METASPACESHARED_HPP