1/*
2 * Copyright (c) 2012, 2019, 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
39class FileMapInfo;
40
41class MetaspaceSharedStats {
42public:
43 MetaspaceSharedStats() {
44 memset(this, 0, sizeof(*this));
45 }
46 CompactHashtableStats symbol;
47 CompactHashtableStats string;
48};
49
50#if INCLUDE_CDS
51class DumpRegion {
52private:
53 const char* _name;
54 char* _base;
55 char* _top;
56 char* _end;
57 bool _is_packed;
58
59public:
60 DumpRegion(const char* name) : _name(name), _base(NULL), _top(NULL), _end(NULL), _is_packed(false) {}
61
62 char* expand_top_to(char* newtop);
63 char* allocate(size_t num_bytes, size_t alignment=BytesPerWord);
64
65 void append_intptr_t(intptr_t n) {
66 assert(is_aligned(_top, sizeof(intptr_t)), "bad alignment");
67 intptr_t *p = (intptr_t*)_top;
68 char* newtop = _top + sizeof(intptr_t);
69 expand_top_to(newtop);
70 *p = n;
71 }
72
73 char* base() const { return _base; }
74 char* top() const { return _top; }
75 char* end() const { return _end; }
76 size_t reserved() const { return _end - _base; }
77 size_t used() const { return _top - _base; }
78 bool is_packed() const { return _is_packed; }
79 bool is_allocatable() const {
80 return !is_packed() && _base != NULL;
81 }
82
83 void print(size_t total_bytes) const;
84 void print_out_of_space_msg(const char* failing_region, size_t needed_bytes);
85
86 void init(const ReservedSpace* rs, char* base) {
87 if (base == NULL) {
88 base = rs->base();
89 }
90 assert(rs->contains(base), "must be");
91 _base = _top = base;
92 _end = rs->end();
93 }
94 void init(char* b, char* t, char* e) {
95 _base = b;
96 _top = t;
97 _end = e;
98 }
99
100 void pack(DumpRegion* next = NULL);
101
102 bool contains(char* p) {
103 return base() <= p && p < top();
104 }
105};
106
107// Closure for serializing initialization data out to a data area to be
108// written to the shared file.
109
110class WriteClosure : public SerializeClosure {
111private:
112 DumpRegion* _dump_region;
113
114public:
115 WriteClosure(DumpRegion* r) {
116 _dump_region = r;
117 }
118
119 void do_ptr(void** p) {
120 _dump_region->append_intptr_t((intptr_t)*p);
121 }
122
123 void do_u4(u4* p) {
124 void* ptr = (void*)(uintx(*p));
125 do_ptr(&ptr);
126 }
127
128 void do_bool(bool *p) {
129 void* ptr = (void*)(uintx(*p));
130 do_ptr(&ptr);
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
147class ReadClosure : public SerializeClosure {
148private:
149 intptr_t** _ptr_array;
150
151 inline intptr_t nextPtr() {
152 return *(*_ptr_array)++;
153 }
154
155public:
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
174
175// Class Data Sharing Support
176class 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 _cds_i2i_entry_code_buffers;
187 static size_t _cds_i2i_entry_code_buffers_size;
188 static size_t _core_spaces_size;
189 static void* _shared_metaspace_static_top;
190 public:
191 enum {
192 // core archive spaces
193 mc = 0, // miscellaneous code for method trampolines
194 rw = 1, // read-write shared space in the heap
195 ro = 2, // read-only shared space in the heap
196 md = 3, // miscellaneous data for initializing tables, etc.
197 num_core_spaces = 4, // number of non-string regions
198 num_non_heap_spaces = 4,
199
200 // mapped java heap regions
201 first_closed_archive_heap_region = md + 1,
202 max_closed_archive_heap_region = 2,
203 last_closed_archive_heap_region = first_closed_archive_heap_region + max_closed_archive_heap_region - 1,
204 first_open_archive_heap_region = last_closed_archive_heap_region + 1,
205 max_open_archive_heap_region = 2,
206 last_open_archive_heap_region = first_open_archive_heap_region + max_open_archive_heap_region - 1,
207
208 last_valid_region = last_open_archive_heap_region,
209 n_regions = last_valid_region + 1 // total number of regions
210 };
211
212 static void prepare_for_dumping() NOT_CDS_RETURN;
213 static void preload_and_dump(TRAPS) NOT_CDS_RETURN;
214 static int preload_classes(const char * class_list_path,
215 TRAPS) NOT_CDS_RETURN_(0);
216
217 static GrowableArray<Klass*>* collected_klasses();
218
219 static ReservedSpace* shared_rs() {
220 CDS_ONLY(return &_shared_rs);
221 NOT_CDS(return NULL);
222 }
223 static void commit_shared_space_to(char* newtop) NOT_CDS_RETURN;
224 static size_t core_spaces_size() {
225 assert(DumpSharedSpaces || UseSharedSpaces, "sanity");
226 assert(_core_spaces_size != 0, "sanity");
227 return _core_spaces_size;
228 }
229 static void initialize_dumptime_shared_and_meta_spaces() NOT_CDS_RETURN;
230 static void initialize_runtime_shared_and_meta_spaces() NOT_CDS_RETURN;
231 static char* initialize_dynamic_runtime_shared_spaces(
232 char* static_start, char* static_end) NOT_CDS_RETURN_(NULL);
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 map_shared_spaces(FileMapInfo* mapinfo) NOT_CDS_RETURN_(false);
249 static void initialize_shared_spaces() NOT_CDS_RETURN;
250
251 // Return true if given address is in the shared metaspace regions (i.e., excluding any
252 // mapped shared heap regions.)
253 static bool is_in_shared_metaspace(const void* p) {
254 // If no shared metaspace regions are mapped, MetaspceObj::_shared_metaspace_{base,top} will
255 // both be NULL and all values of p will be rejected quickly.
256 return (p < MetaspaceObj::shared_metaspace_top() && p >= MetaspaceObj::shared_metaspace_base());
257 }
258
259 static address shared_metaspace_top() {
260 return (address)MetaspaceObj::shared_metaspace_top();
261 }
262
263 static void set_shared_metaspace_range(void* base, void* top) NOT_CDS_RETURN;
264
265 // Return true if given address is in the shared region corresponding to the idx
266 static bool is_in_shared_region(const void* p, int idx) NOT_CDS_RETURN_(false);
267
268 static bool is_in_trampoline_frame(address addr) NOT_CDS_RETURN_(false);
269
270 static bool is_shared_dynamic(void* p) NOT_CDS_RETURN_(false);
271
272 static void allocate_cpp_vtable_clones();
273 static intptr_t* clone_cpp_vtables(intptr_t* p);
274 static void zero_cpp_vtable_clones_for_writing();
275 static void patch_cpp_vtable_pointers();
276 static void serialize_cloned_cpp_vtptrs(SerializeClosure* sc);
277
278 static bool is_valid_shared_method(const Method* m) NOT_CDS_RETURN_(false);
279 static void serialize(SerializeClosure* sc) NOT_CDS_RETURN;
280
281 static MetaspaceSharedStats* stats() {
282 return &_stats;
283 }
284
285 static void report_out_of_space(const char* name, size_t needed_bytes);
286
287 // JVM/TI RedefineClasses() support:
288 // Remap the shared readonly space to shared readwrite, private if
289 // sharing is enabled. Simply returns true if sharing is not enabled
290 // or if the remapping has already been done by a prior call.
291 static bool remap_shared_readonly_as_readwrite() NOT_CDS_RETURN_(true);
292 static bool remapped_readwrite() {
293 CDS_ONLY(return _remapped_readwrite);
294 NOT_CDS(return false);
295 }
296
297 static bool try_link_class(InstanceKlass* ik, TRAPS);
298 static void link_and_cleanup_shared_classes(TRAPS);
299
300#if INCLUDE_CDS
301 static ReservedSpace* reserve_shared_rs(size_t size, size_t alignment,
302 bool large, char* requested_address);
303 static void init_shared_dump_space(DumpRegion* first_space, address first_space_bottom = NULL);
304 static DumpRegion* misc_code_dump_space();
305 static DumpRegion* read_write_dump_space();
306 static DumpRegion* read_only_dump_space();
307 static void pack_dump_space(DumpRegion* current, DumpRegion* next,
308 ReservedSpace* rs);
309
310 static void rewrite_nofast_bytecodes_and_calculate_fingerprints(InstanceKlass* ik);
311#endif
312
313 // Allocate a block of memory from the "mc", "ro", or "rw" regions.
314 static char* misc_code_space_alloc(size_t num_bytes);
315 static char* read_only_space_alloc(size_t num_bytes);
316
317 template <typename T>
318 static Array<T>* new_ro_array(int length) {
319#if INCLUDE_CDS
320 size_t byte_size = Array<T>::byte_sizeof(length, sizeof(T));
321 Array<T>* array = (Array<T>*)read_only_space_alloc(byte_size);
322 array->initialize(length);
323 return array;
324#else
325 return NULL;
326#endif
327 }
328
329 template <typename T>
330 static size_t ro_array_bytesize(int length) {
331 size_t byte_size = Array<T>::byte_sizeof(length, sizeof(T));
332 return align_up(byte_size, BytesPerWord);
333 }
334
335 static address cds_i2i_entry_code_buffers(size_t total_size);
336
337 static address cds_i2i_entry_code_buffers() {
338 return _cds_i2i_entry_code_buffers;
339 }
340 static size_t cds_i2i_entry_code_buffers_size() {
341 return _cds_i2i_entry_code_buffers_size;
342 }
343 static void relocate_klass_ptr(oop o);
344
345 static Klass* get_relocated_klass(Klass *k);
346
347 static intptr_t* fix_cpp_vtable_for_dynamic_archive(MetaspaceObj::Type msotype, address obj);
348
349private:
350 static void read_extra_data(const char* filename, TRAPS) NOT_CDS_RETURN;
351};
352#endif // SHARE_MEMORY_METASPACESHARED_HPP
353