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 address _cds_i2i_entry_code_buffers;
62 static size_t _cds_i2i_entry_code_buffers_size;
63 static size_t _core_spaces_size;
64 public:
65 enum {
66 // core archive spaces
67 mc = 0, // miscellaneous code for method trampolines
68 rw = 1, // read-write shared space in the heap
69 ro = 2, // read-only shared space in the heap
70 md = 3, // miscellaneous data for initializing tables, etc.
71 num_core_spaces = 4, // number of non-string regions
72
73 // optional mapped spaces
74 // Currently it only contains class file data.
75 od = num_core_spaces,
76 num_non_heap_spaces = od + 1,
77
78 // mapped java heap regions
79 first_string = od + 1, // index of first string region
80 max_strings = 2, // max number of string regions in string space
81 last_string = first_string + max_strings - 1,
82 first_open_archive_heap_region = first_string + max_strings,
83 max_open_archive_heap_region = 2,
84
85 last_valid_region = first_open_archive_heap_region + max_open_archive_heap_region - 1,
86 n_regions = last_valid_region + 1 // total number of regions
87 };
88
89 static void prepare_for_dumping() NOT_CDS_RETURN;
90 static void preload_and_dump(TRAPS) NOT_CDS_RETURN;
91 static int preload_classes(const char * class_list_path,
92 TRAPS) NOT_CDS_RETURN_(0);
93
94 static GrowableArray<Klass*>* collected_klasses();
95
96 static ReservedSpace* shared_rs() {
97 CDS_ONLY(return &_shared_rs);
98 NOT_CDS(return NULL);
99 }
100 static void commit_shared_space_to(char* newtop) NOT_CDS_RETURN;
101 static size_t core_spaces_size() {
102 return _core_spaces_size;
103 }
104 static void initialize_dumptime_shared_and_meta_spaces() NOT_CDS_RETURN;
105 static void initialize_runtime_shared_and_meta_spaces() NOT_CDS_RETURN;
106 static void post_initialize(TRAPS) NOT_CDS_RETURN;
107
108 // Delta of this object from the bottom of the archive.
109 static uintx object_delta(void* obj) {
110 assert(DumpSharedSpaces, "supported only for dumping");
111 assert(shared_rs()->contains(obj), "must be");
112 address base_address = address(shared_rs()->base());
113 uintx delta = address(obj) - base_address;
114 return delta;
115 }
116
117 static void set_archive_loading_failed() {
118 _archive_loading_failed = true;
119 }
120 static bool map_shared_spaces(FileMapInfo* mapinfo) NOT_CDS_RETURN_(false);
121 static void initialize_shared_spaces() NOT_CDS_RETURN;
122
123 // Return true if given address is in the shared metaspace regions (i.e., excluding any
124 // mapped shared heap regions.)
125 static bool is_in_shared_metaspace(const void* p) {
126 // If no shared metaspace regions are mapped, MetaspceObj::_shared_metaspace_{base,top} will
127 // both be NULL and all values of p will be rejected quickly.
128 return (p < MetaspaceObj::_shared_metaspace_top && p >= MetaspaceObj::_shared_metaspace_base);
129 }
130
131 // Return true if given address is in the shared region corresponding to the idx
132 static bool is_in_shared_region(const void* p, int idx) NOT_CDS_RETURN_(false);
133
134 static bool is_heap_region(int idx) {
135 CDS_JAVA_HEAP_ONLY(return (idx >= MetaspaceShared::first_string &&
136 idx < MetaspaceShared::first_open_archive_heap_region +
137 MetaspaceShared::max_open_archive_heap_region));
138 NOT_CDS_JAVA_HEAP_RETURN_(false);
139 }
140 static bool is_string_region(int idx) {
141 CDS_JAVA_HEAP_ONLY(return (idx >= MetaspaceShared::first_string &&
142 idx < MetaspaceShared::first_string + MetaspaceShared::max_strings));
143 NOT_CDS_JAVA_HEAP_RETURN_(false);
144 }
145 static bool is_open_archive_heap_region(int idx) {
146 CDS_JAVA_HEAP_ONLY(return (idx >= MetaspaceShared::first_open_archive_heap_region &&
147 idx < MetaspaceShared::first_open_archive_heap_region +
148 MetaspaceShared::max_open_archive_heap_region));
149 NOT_CDS_JAVA_HEAP_RETURN_(false);
150 }
151 static bool is_in_trampoline_frame(address addr) NOT_CDS_RETURN_(false);
152
153 static void allocate_cpp_vtable_clones();
154 static intptr_t* clone_cpp_vtables(intptr_t* p);
155 static void zero_cpp_vtable_clones_for_writing();
156 static void patch_cpp_vtable_pointers();
157 static bool is_valid_shared_method(const Method* m) NOT_CDS_RETURN_(false);
158 static void serialize(SerializeClosure* sc) NOT_CDS_RETURN;
159
160 static MetaspaceSharedStats* stats() {
161 return &_stats;
162 }
163
164 static void report_out_of_space(const char* name, size_t needed_bytes);
165
166 // JVM/TI RedefineClasses() support:
167 // Remap the shared readonly space to shared readwrite, private if
168 // sharing is enabled. Simply returns true if sharing is not enabled
169 // or if the remapping has already been done by a prior call.
170 static bool remap_shared_readonly_as_readwrite() NOT_CDS_RETURN_(true);
171 static bool remapped_readwrite() {
172 CDS_ONLY(return _remapped_readwrite);
173 NOT_CDS(return false);
174 }
175
176 static bool try_link_class(InstanceKlass* ik, TRAPS);
177 static void link_and_cleanup_shared_classes(TRAPS);
178 static void check_shared_class_loader_type(InstanceKlass* ik);
179
180 // Allocate a block of memory from the "mc", "ro", or "rw" regions.
181 static char* misc_code_space_alloc(size_t num_bytes);
182 static char* read_only_space_alloc(size_t num_bytes);
183
184 static char* read_only_space_top();
185
186 template <typename T>
187 static Array<T>* new_ro_array(int length) {
188 #if INCLUDE_CDS
189 size_t byte_size = Array<T>::byte_sizeof(length, sizeof(T));
190 Array<T>* array = (Array<T>*)read_only_space_alloc(byte_size);
191 array->initialize(length);
192 return array;
193 #else
194 return NULL;
195 #endif
196 }
197
198 static address cds_i2i_entry_code_buffers(size_t total_size);
199
200 static address cds_i2i_entry_code_buffers() {
201 return _cds_i2i_entry_code_buffers;
202 }
203 static size_t cds_i2i_entry_code_buffers_size() {
204 return _cds_i2i_entry_code_buffers_size;
205 }
206 static void relocate_klass_ptr(oop o);
207
208 static Klass* get_relocated_klass(Klass *k);
209
210 private:
211 static void read_extra_data(const char* filename, TRAPS) NOT_CDS_RETURN;
212 };
213 #endif // SHARE_VM_MEMORY_METASPACESHARED_HPP