1 /*
2 * Copyright (c) 2012, 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_METASPACESHARED_HPP
26 #define SHARE_VM_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
41 class MetaspaceSharedStats {
42 public:
43 MetaspaceSharedStats() {
44 memset(this, 0, sizeof(*this));
45 }
46 CompactHashtableStats symbol;
47 CompactHashtableStats string;
48 };
49
50 // Class Data Sharing Support
51 class MetaspaceShared : AllStatic {
52
53 // CDS support
54 static ReservedSpace _shared_rs;
55 static VirtualSpace _shared_vs;
56 static int _max_alignment;
57 static MetaspaceSharedStats _stats;
58 static bool _has_error_classes;
59 static bool _archive_loading_failed;
60 static bool _remapped_readwrite;
61 static bool _open_archive_heap_region_mapped;
62 static bool _archive_heap_region_fixed;
63 static address _cds_i2i_entry_code_buffers;
64 static size_t _cds_i2i_entry_code_buffers_size;
65 static size_t _core_spaces_size;
66 public:
67 enum {
68 // core archive spaces
69 mc = 0, // miscellaneous code for method trampolines
70 rw = 1, // read-write shared space in the heap
71 ro = 2, // read-only shared space in the heap
72 md = 3, // miscellaneous data for initializing tables, etc.
73 num_core_spaces = 4, // number of non-string regions
74
75 // optional mapped spaces
76 // Currently it only contains class file data.
77 od = num_core_spaces,
78 num_non_heap_spaces = od + 1,
79
80 // mapped java heap regions
81 first_string = od + 1, // index of first string region
82 max_strings = 2, // max number of string regions in string space
83 last_string = first_string + max_strings - 1,
84 first_open_archive_heap_region = first_string + max_strings,
85 max_open_archive_heap_region = 2,
86
87 last_valid_region = first_open_archive_heap_region + max_open_archive_heap_region - 1,
88 n_regions = last_valid_region + 1 // total number of regions
89 };
90
91 static void prepare_for_dumping() NOT_CDS_RETURN;
92 static void preload_and_dump(TRAPS) NOT_CDS_RETURN;
93 static int preload_classes(const char * class_list_path,
94 TRAPS) NOT_CDS_RETURN_(0);
95
96 #if INCLUDE_CDS_JAVA_HEAP
97 private:
98 static bool obj_equals(oop const& p1, oop const& p2) {
99 return p1 == p2;
100 }
101 static unsigned obj_hash(oop const& p);
102
103 typedef ResourceHashtable<oop, oop,
104 MetaspaceShared::obj_hash,
105 MetaspaceShared::obj_equals,
106 15889, // prime number
107 ResourceObj::C_HEAP> ArchivedObjectCache;
108 static ArchivedObjectCache* _archive_object_cache;
109
110 public:
111 static ArchivedObjectCache* archive_object_cache() {
112 return _archive_object_cache;
113 }
114 static oop find_archived_heap_object(oop obj);
115 static oop archive_heap_object(oop obj, Thread* THREAD);
116 static oop materialize_archived_object(narrowOop v);
117 static void archive_klass_objects(Thread* THREAD);
118
119 static void set_archive_heap_region_fixed() {
120 _archive_heap_region_fixed = true;
121 }
122
123 static bool archive_heap_region_fixed() {
124 return _archive_heap_region_fixed;
125 }
126 #endif
127
128 static bool is_archive_object(oop p) NOT_CDS_JAVA_HEAP_RETURN_(false);
129
130 static bool is_heap_object_archiving_allowed() {
131 CDS_JAVA_HEAP_ONLY(return (UseG1GC && UseCompressedOops && UseCompressedClassPointers);)
132 NOT_CDS_JAVA_HEAP(return false;)
133 }
134 static void create_archive_object_cache() {
135 CDS_JAVA_HEAP_ONLY(_archive_object_cache = new (ResourceObj::C_HEAP, mtClass)ArchivedObjectCache(););
136 }
137 static void destroy_archive_object_cache() {
138 CDS_JAVA_HEAP_ONLY(delete _archive_object_cache; _archive_object_cache = NULL;);
139 }
140 static void fixup_mapped_heap_regions() NOT_CDS_JAVA_HEAP_RETURN;
141
142 static void dump_closed_archive_heap_objects(GrowableArray<MemRegion> * closed_archive) NOT_CDS_JAVA_HEAP_RETURN;
143
144 static void dump_open_archive_heap_objects(GrowableArray<MemRegion> * open_archive) NOT_CDS_JAVA_HEAP_RETURN;
145 static void set_open_archive_heap_region_mapped() {
146 CDS_JAVA_HEAP_ONLY(_open_archive_heap_region_mapped = true);
147 NOT_CDS_JAVA_HEAP_RETURN;
148 }
149 static bool open_archive_heap_region_mapped() {
150 CDS_JAVA_HEAP_ONLY(return _open_archive_heap_region_mapped);
151 NOT_CDS_JAVA_HEAP_RETURN_(false);
152 }
153
154 static ReservedSpace* shared_rs() {
155 CDS_ONLY(return &_shared_rs);
156 NOT_CDS(return NULL);
157 }
158 static void commit_shared_space_to(char* newtop) NOT_CDS_RETURN;
159 static size_t core_spaces_size() {
160 return _core_spaces_size;
161 }
162 static void initialize_dumptime_shared_and_meta_spaces() NOT_CDS_RETURN;
163 static void initialize_runtime_shared_and_meta_spaces() NOT_CDS_RETURN;
164 static void post_initialize(TRAPS) NOT_CDS_RETURN;
165
166 // Delta of this object from the bottom of the archive.
167 static uintx object_delta(void* obj) {
168 assert(DumpSharedSpaces, "supported only for dumping");
169 assert(shared_rs()->contains(obj), "must be");
170 address base_address = address(shared_rs()->base());
171 uintx delta = address(obj) - base_address;
172 return delta;
173 }
174
175 static void set_archive_loading_failed() {
176 _archive_loading_failed = true;
177 }
178 static bool map_shared_spaces(FileMapInfo* mapinfo) NOT_CDS_RETURN_(false);
179 static void initialize_shared_spaces() NOT_CDS_RETURN;
180
181 // Return true if given address is in the shared metaspace regions (i.e., excluding any
182 // mapped shared heap regions.)
183 static bool is_in_shared_metaspace(const void* p) {
184 // If no shared metaspace regions are mapped, MetaspceObj::_shared_metaspace_{base,top} will
185 // both be NULL and all values of p will be rejected quickly.
186 return (p < MetaspaceObj::_shared_metaspace_top && p >= MetaspaceObj::_shared_metaspace_base);
187 }
188
189 // Return true if given address is in the shared region corresponding to the idx
190 static bool is_in_shared_region(const void* p, int idx) NOT_CDS_RETURN_(false);
191
192 static bool is_heap_region(int idx) {
193 CDS_JAVA_HEAP_ONLY(return (idx >= MetaspaceShared::first_string &&
194 idx < MetaspaceShared::first_open_archive_heap_region +
195 MetaspaceShared::max_open_archive_heap_region));
196 NOT_CDS_JAVA_HEAP_RETURN_(false);
197 }
198 static bool is_string_region(int idx) {
199 CDS_JAVA_HEAP_ONLY(return (idx >= MetaspaceShared::first_string &&
200 idx < MetaspaceShared::first_string + MetaspaceShared::max_strings));
201 NOT_CDS_JAVA_HEAP_RETURN_(false);
202 }
203 static bool is_open_archive_heap_region(int idx) {
204 CDS_JAVA_HEAP_ONLY(return (idx >= MetaspaceShared::first_open_archive_heap_region &&
205 idx < MetaspaceShared::first_open_archive_heap_region +
206 MetaspaceShared::max_open_archive_heap_region));
207 NOT_CDS_JAVA_HEAP_RETURN_(false);
208 }
209 static bool is_in_trampoline_frame(address addr) NOT_CDS_RETURN_(false);
210
211 static void allocate_cpp_vtable_clones();
212 static intptr_t* clone_cpp_vtables(intptr_t* p);
213 static void zero_cpp_vtable_clones_for_writing();
214 static void patch_cpp_vtable_pointers();
215 static bool is_valid_shared_method(const Method* m) NOT_CDS_RETURN_(false);
216 static void serialize(SerializeClosure* sc) NOT_CDS_RETURN;
217
218 static MetaspaceSharedStats* stats() {
219 return &_stats;
220 }
221
222 static void report_out_of_space(const char* name, size_t needed_bytes);
223
224 // JVM/TI RedefineClasses() support:
225 // Remap the shared readonly space to shared readwrite, private if
226 // sharing is enabled. Simply returns true if sharing is not enabled
227 // or if the remapping has already been done by a prior call.
228 static bool remap_shared_readonly_as_readwrite() NOT_CDS_RETURN_(true);
229 static bool remapped_readwrite() {
230 CDS_ONLY(return _remapped_readwrite);
231 NOT_CDS(return false);
232 }
233
234 static bool try_link_class(InstanceKlass* ik, TRAPS);
235 static void link_and_cleanup_shared_classes(TRAPS);
236 static void check_shared_class_loader_type(InstanceKlass* ik);
237
238 // Allocate a block of memory from the "mc", "ro", or "rw" regions.
239 static char* misc_code_space_alloc(size_t num_bytes);
240 static char* read_only_space_alloc(size_t num_bytes);
241
242 static char* read_only_space_top();
243
244 template <typename T>
245 static Array<T>* new_ro_array(int length) {
246 #if INCLUDE_CDS
247 size_t byte_size = Array<T>::byte_sizeof(length, sizeof(T));
248 Array<T>* array = (Array<T>*)read_only_space_alloc(byte_size);
249 array->initialize(length);
250 return array;
251 #else
252 return NULL;
253 #endif
254 }
255
256 static address cds_i2i_entry_code_buffers(size_t total_size);
257
258 static address cds_i2i_entry_code_buffers() {
259 return _cds_i2i_entry_code_buffers;
260 }
261 static size_t cds_i2i_entry_code_buffers_size() {
262 return _cds_i2i_entry_code_buffers_size;
263 }
264 static void relocate_klass_ptr(oop o);
265
266 static Klass* get_relocated_klass(Klass *k);
267
268 private:
269 static void read_extra_data(const char* filename, TRAPS) NOT_CDS_RETURN;
270 };
271 #endif // SHARE_VM_MEMORY_METASPACESHARED_HPP