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