1 /*
2 * Copyright (c) 2011, 2014, 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 #ifndef SHARE_VM_MEMORY_METASPACE_HPP
25 #define SHARE_VM_MEMORY_METASPACE_HPP
26
27 #include "memory/allocation.hpp"
28 #include "memory/memRegion.hpp"
29 #include "memory/metaspaceChunkFreeListSummary.hpp"
30 #include "runtime/virtualspace.hpp"
31 #include "utilities/exceptions.hpp"
32
33 // Metaspace
34 //
35 // Metaspaces are Arenas for the VM's metadata.
36 // They are allocated one per class loader object, and one for the null
37 // bootstrap class loader
38 // Eventually for bootstrap loader we'll have a read-only section and read-write
39 // to write for DumpSharedSpaces and read for UseSharedSpaces
40 //
41 // block X ---+ +-------------------+
42 // | | Virtualspace |
43 // | | |
44 // | | |
45 // | |-------------------|
46 // | || Chunk |
47 // | || |
48 // | ||---------- |
49 // +------>||| block 0 | |
50 // ||---------- |
51 // ||| block 1 | |
52 // ||---------- |
53 // || |
54 // |-------------------|
55 // | |
56 // | |
57 // +-------------------+
58 //
59
60 class ChunkManager;
61 class ClassLoaderData;
62 class Metablock;
63 class Metachunk;
64 class MetaspaceTracer;
65 class MetaWord;
66 class Mutex;
67 class outputStream;
68 class SpaceManager;
69 class VirtualSpaceList;
70
71 // Metaspaces each have a SpaceManager and allocations
72 // are done by the SpaceManager. Allocations are done
73 // out of the current Metachunk. When the current Metachunk
74 // is exhausted, the SpaceManager gets a new one from
75 // the current VirtualSpace. When the VirtualSpace is exhausted
76 // the SpaceManager gets a new one. The SpaceManager
77 // also manages freelists of available Chunks.
78 //
79 // Currently the space manager maintains the list of
80 // virtual spaces and the list of chunks in use. Its
81 // allocate() method returns a block for use as a
82 // quantum of metadata.
83
84 class Metaspace : public CHeapObj<mtClass> {
85 friend class VMStructs;
86 friend class SpaceManager;
87 friend class VM_CollectForMetadataAllocation;
88 friend class MetaspaceGC;
89 friend class MetaspaceAux;
90
91 public:
92 enum MetadataType {
93 ClassType,
94 NonClassType,
95 MetadataTypeCount
96 };
97 enum MetaspaceType {
98 StandardMetaspaceType,
99 BootMetaspaceType,
100 ROMetaspaceType,
101 ReadWriteMetaspaceType,
102 AnonymousMetaspaceType,
103 ReflectionMetaspaceType
104 };
105
106 private:
107 void initialize(Mutex* lock, MetaspaceType type);
108
109 // Get the first chunk for a Metaspace. Used for
110 // special cases such as the boot class loader, reflection
111 // class loader and anonymous class loader.
112 Metachunk* get_initialization_chunk(MetadataType mdtype,
113 size_t chunk_word_size,
114 size_t chunk_bunch);
115
116 // Align up the word size to the allocation word size
117 static size_t align_word_size_up(size_t);
118
119 // Aligned size of the metaspace.
120 static size_t _compressed_class_space_size;
121
122 static size_t compressed_class_space_size() {
123 return _compressed_class_space_size;
124 }
125
126 static void set_compressed_class_space_size(size_t size) {
127 _compressed_class_space_size = size;
128 }
129
130 static size_t _first_chunk_word_size;
131 static size_t _first_class_chunk_word_size;
132
133 static size_t _commit_alignment;
134 static size_t _reserve_alignment;
135
136 SpaceManager* _vsm;
137 SpaceManager* vsm() const { return _vsm; }
138
139 SpaceManager* _class_vsm;
140 SpaceManager* class_vsm() const { return _class_vsm; }
141
142 // Allocate space for metadata of type mdtype. This is space
143 // within a Metachunk and is used by
144 // allocate(ClassLoaderData*, size_t, bool, MetadataType, TRAPS)
145 MetaWord* allocate(size_t word_size, MetadataType mdtype);
146
147 // Virtual Space lists for both classes and other metadata
148 static VirtualSpaceList* _space_list;
149 static VirtualSpaceList* _class_space_list;
150
151 static ChunkManager* _chunk_manager_metadata;
152 static ChunkManager* _chunk_manager_class;
153
154 static const MetaspaceTracer* _tracer;
155
156 public:
157 static VirtualSpaceList* space_list() { return _space_list; }
158 static VirtualSpaceList* class_space_list() { return _class_space_list; }
159 static VirtualSpaceList* get_space_list(MetadataType mdtype) {
160 assert(mdtype != MetadataTypeCount, "MetadaTypeCount can't be used as mdtype");
161 return mdtype == ClassType ? class_space_list() : space_list();
162 }
163
164 static ChunkManager* chunk_manager_metadata() { return _chunk_manager_metadata; }
165 static ChunkManager* chunk_manager_class() { return _chunk_manager_class; }
166 static ChunkManager* get_chunk_manager(MetadataType mdtype) {
167 assert(mdtype != MetadataTypeCount, "MetadaTypeCount can't be used as mdtype");
168 return mdtype == ClassType ? chunk_manager_class() : chunk_manager_metadata();
169 }
170
171 static const MetaspaceTracer* tracer() { return _tracer; }
172
173 private:
174 // This is used by DumpSharedSpaces only, where only _vsm is used. So we will
175 // maintain a single list for now.
176 void record_allocation(void* ptr, MetaspaceObj::Type type, size_t word_size);
177
178 #ifdef _LP64
179 static void set_narrow_klass_base_and_shift(address metaspace_base, address cds_base);
180
181 // Returns true if can use CDS with metaspace allocated as specified address.
182 static bool can_use_cds_with_metaspace_addr(char* metaspace_base, address cds_base);
183
184 static void allocate_metaspace_compressed_klass_ptrs(char* requested_addr, address cds_base);
185
186 static void initialize_class_space(ReservedSpace rs);
187 #endif
188
189 class AllocRecord : public CHeapObj<mtClass> {
190 public:
191 AllocRecord(address ptr, MetaspaceObj::Type type, int byte_size)
192 : _next(NULL), _ptr(ptr), _type(type), _byte_size(byte_size) {}
193 AllocRecord *_next;
194 address _ptr;
195 MetaspaceObj::Type _type;
196 int _byte_size;
197 };
198
199 AllocRecord * _alloc_record_head;
200 AllocRecord * _alloc_record_tail;
201
202 size_t class_chunk_size(size_t word_size);
203
204 public:
205
206 Metaspace(Mutex* lock, MetaspaceType type);
207 ~Metaspace();
208
209 static void ergo_initialize();
210 static void global_initialize();
211 static void post_initialize();
212
213 static size_t first_chunk_word_size() { return _first_chunk_word_size; }
214 static size_t first_class_chunk_word_size() { return _first_class_chunk_word_size; }
215
216 static size_t reserve_alignment() { return _reserve_alignment; }
217 static size_t reserve_alignment_words() { return _reserve_alignment / BytesPerWord; }
218 static size_t commit_alignment() { return _commit_alignment; }
219 static size_t commit_alignment_words() { return _commit_alignment / BytesPerWord; }
220
221 char* bottom() const;
222 size_t used_words_slow(MetadataType mdtype) const;
223 size_t free_words_slow(MetadataType mdtype) const;
224 size_t capacity_words_slow(MetadataType mdtype) const;
225
226 size_t used_bytes_slow(MetadataType mdtype) const;
227 size_t capacity_bytes_slow(MetadataType mdtype) const;
228
229 size_t allocated_blocks_bytes() const;
230 size_t allocated_chunks_bytes() const;
231
232 static MetaWord* allocate(ClassLoaderData* loader_data, size_t word_size,
233 bool read_only, MetaspaceObj::Type type, TRAPS);
234 void deallocate(MetaWord* ptr, size_t byte_size, bool is_class);
235
236 MetaWord* expand_and_allocate(size_t size,
237 MetadataType mdtype);
238
239 static bool contains(const void* ptr);
240
241 void dump(outputStream* const out) const;
242
243 // Free empty virtualspaces
244 static void purge(MetadataType mdtype);
245 static void purge();
246
247 static void report_metadata_oome(ClassLoaderData* loader_data, size_t word_size,
248 MetaspaceObj::Type type, MetadataType mdtype, TRAPS);
249
250 static const char* metadata_type_name(Metaspace::MetadataType mdtype);
251
252 void print_on(outputStream* st) const;
253 // Debugging support
254 void verify();
255
256 class AllocRecordClosure : public StackObj {
257 public:
258 virtual void doit(address ptr, MetaspaceObj::Type type, int byte_size) = 0;
259 };
260
261 void iterate(AllocRecordClosure *closure);
262
263 // Return TRUE only if UseCompressedClassPointers is True and DumpSharedSpaces is False.
264 static bool using_class_space() {
265 return NOT_LP64(false) LP64_ONLY(UseCompressedClassPointers && !DumpSharedSpaces);
266 }
267
268 static bool is_class_space_allocation(MetadataType mdType) {
269 return mdType == ClassType && using_class_space();
270 }
271
272 };
273
274 class MetaspaceAux : AllStatic {
275 static size_t free_chunks_total_words(Metaspace::MetadataType mdtype);
276
277 // These methods iterate over the classloader data graph
278 // for the given Metaspace type. These are slow.
279 static size_t used_bytes_slow(Metaspace::MetadataType mdtype);
280 static size_t free_bytes_slow(Metaspace::MetadataType mdtype);
281 static size_t capacity_bytes_slow(Metaspace::MetadataType mdtype);
282 static size_t capacity_bytes_slow();
283
284 // Running sum of space in all Metachunks that has been
285 // allocated to a Metaspace. This is used instead of
286 // iterating over all the classloaders. One for each
287 // type of Metadata
288 static size_t _capacity_words[Metaspace:: MetadataTypeCount];
289 // Running sum of space in all Metachunks that
290 // are being used for metadata. One for each
291 // type of Metadata.
292 static size_t _used_words[Metaspace:: MetadataTypeCount];
293
294 public:
295 // Decrement and increment _allocated_capacity_words
296 static void dec_capacity(Metaspace::MetadataType type, size_t words);
297 static void inc_capacity(Metaspace::MetadataType type, size_t words);
298
299 // Decrement and increment _allocated_used_words
300 static void dec_used(Metaspace::MetadataType type, size_t words);
301 static void inc_used(Metaspace::MetadataType type, size_t words);
302
303 // Total of space allocated to metadata in all Metaspaces.
304 // This sums the space used in each Metachunk by
305 // iterating over the classloader data graph
306 static size_t used_bytes_slow() {
307 return used_bytes_slow(Metaspace::ClassType) +
308 used_bytes_slow(Metaspace::NonClassType);
309 }
310
311 // Used by MetaspaceCounters
312 static size_t free_chunks_total_words();
313 static size_t free_chunks_total_bytes();
314 static size_t free_chunks_total_bytes(Metaspace::MetadataType mdtype);
315
316 static size_t capacity_words(Metaspace::MetadataType mdtype) {
317 return _capacity_words[mdtype];
318 }
319 static size_t capacity_words() {
320 return capacity_words(Metaspace::NonClassType) +
321 capacity_words(Metaspace::ClassType);
322 }
323 static size_t capacity_bytes(Metaspace::MetadataType mdtype) {
324 return capacity_words(mdtype) * BytesPerWord;
325 }
326 static size_t capacity_bytes() {
327 return capacity_words() * BytesPerWord;
328 }
329
330 static size_t used_words(Metaspace::MetadataType mdtype) {
331 return _used_words[mdtype];
332 }
333 static size_t used_words() {
334 return used_words(Metaspace::NonClassType) +
335 used_words(Metaspace::ClassType);
336 }
337 static size_t used_bytes(Metaspace::MetadataType mdtype) {
338 return used_words(mdtype) * BytesPerWord;
339 }
340 static size_t used_bytes() {
341 return used_words() * BytesPerWord;
342 }
343
344 static size_t free_bytes();
345 static size_t free_bytes(Metaspace::MetadataType mdtype);
346
347 static size_t reserved_bytes(Metaspace::MetadataType mdtype);
348 static size_t reserved_bytes() {
349 return reserved_bytes(Metaspace::ClassType) +
350 reserved_bytes(Metaspace::NonClassType);
351 }
352
353 static size_t committed_bytes(Metaspace::MetadataType mdtype);
354 static size_t committed_bytes() {
355 return committed_bytes(Metaspace::ClassType) +
356 committed_bytes(Metaspace::NonClassType);
357 }
358
359 static size_t min_chunk_size_words();
360 static size_t min_chunk_size_bytes() {
361 return min_chunk_size_words() * BytesPerWord;
362 }
363
364 static bool has_chunk_free_list(Metaspace::MetadataType mdtype);
365 static MetaspaceChunkFreeListSummary chunk_free_list_summary(Metaspace::MetadataType mdtype);
366
367 // Print change in used metadata.
368 static void print_metaspace_change(size_t prev_metadata_used);
369 static void print_on(outputStream * out);
370 static void print_on(outputStream * out, Metaspace::MetadataType mdtype);
371
372 static void print_class_waste(outputStream* out);
373 static void print_waste(outputStream* out);
374 static void dump(outputStream* out);
375 static void verify_free_chunks();
376 // Checks that the values returned by allocated_capacity_bytes() and
377 // capacity_bytes_slow() are the same.
378 static void verify_capacity();
379 static void verify_used();
380 static void verify_metrics();
381 };
382
383 // Metaspace are deallocated when their class loader are GC'ed.
384 // This class implements a policy for inducing GC's to recover
385 // Metaspaces.
386
387 class MetaspaceGC : AllStatic {
388
389 // The current high-water-mark for inducing a GC.
390 // When committed memory of all metaspaces reaches this value,
391 // a GC is induced and the value is increased. Size is in bytes.
392 static volatile intptr_t _capacity_until_GC;
393
394 // For a CMS collection, signal that a concurrent collection should
395 // be started.
396 static bool _should_concurrent_collect;
397
398 static uint _shrink_factor;
399
400 static size_t shrink_factor() { return _shrink_factor; }
401 void set_shrink_factor(uint v) { _shrink_factor = v; }
402
403 public:
404
405 static void initialize();
406 static void post_initialize();
407
408 static size_t capacity_until_GC();
409 static size_t inc_capacity_until_GC(size_t v);
410 static size_t dec_capacity_until_GC(size_t v);
411
412 static bool should_concurrent_collect() { return _should_concurrent_collect; }
413 static void set_should_concurrent_collect(bool v) {
414 _should_concurrent_collect = v;
415 }
416
417 // The amount to increase the high-water-mark (_capacity_until_GC)
418 static size_t delta_capacity_until_GC(size_t bytes);
419
420 // Tells if we have can expand metaspace without hitting set limits.
421 static bool can_expand(size_t words, bool is_class);
422
423 // Returns amount that we can expand without hitting a GC,
424 // measured in words.
425 static size_t allowed_expansion();
426
427 // Calculate the new high-water mark at which to induce
428 // a GC.
429 static void compute_new_size();
430 };
431
432 #endif // SHARE_VM_MEMORY_METASPACE_HPP