1 /*
2 * Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2018, 2020 SAP SE. All rights reserved.
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * This code is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 only, as
8 * published by the Free Software Foundation.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 *
24 */
25
26 #ifndef SHARE_MEMORY_METASPACE_METASPACECOMMON_HPP
27 #define SHARE_MEMORY_METASPACE_METASPACECOMMON_HPP
28
29 #include "oops/compressedKlass.hpp"
30 #include "runtime/globals.hpp"
31 #include "utilities/align.hpp"
32 #include "utilities/debug.hpp"
33 #include "utilities/globalDefinitions.hpp"
34
35 class outputStream;
36
37 namespace metaspace {
38
39 // Metaspace allocation alignment:
40
41 // Metaspace allocations have to be aligned such that 64-bit values are aligned
42 // correctly. We currently don't hold members with a larger alignment requirement
43 // than 64-bit inside MetaData, so 8-byte alignment is enough.
44 //
45 // Klass* structures need to be aligned to Klass* alignment,
46 //
47 // On 64-bit platforms, we align to word size; on 32-bit, we align to two words.
48
49 static const size_t AllocationAlignmentByteSize = 8;
50
51 static const size_t AllocationAlignmentWordSize = AllocationAlignmentByteSize / BytesPerWord;
52
53 // Returns the raw word size allocated for a given net allocation. This only matters on 32-bit, where
54 // allocations have to be 64-bit aligned too and therefore must be 2-word-aligned.
55 inline size_t get_raw_word_size_for_requested_word_size(size_t word_size) {
56 LP64_ONLY(STATIC_ASSERT(AllocationAlignmentWordSize == 1)); // rewrite if this does not hold true anymore
57 return LP64_ONLY(word_size) // no-op on 64-bit
58 NOT_LP64(align_up(word_size, AllocationAlignmentWordSize));
59 }
60
61 // Utility functions
62
63 // Print a size, in words, scaled.
64 void print_scaled_words(outputStream* st, size_t word_size, size_t scale = 0, int width = -1);
65
66 // Convenience helper: prints a size value and a percentage.
67 void print_scaled_words_and_percentage(outputStream* st, size_t word_size, size_t compare_word_size, size_t scale = 0, int width = -1);
68
69 // Print a human readable size.
70 // byte_size: size, in bytes, to be printed.
71 // scale: one of 1 (byte-wise printing), sizeof(word) (word-size printing), K, M, G (scaled by KB, MB, GB respectively,
72 // or 0, which means the best scale is chosen dynamically.
73 // width: printing width.
74 void print_human_readable_size(outputStream* st, size_t byte_size, size_t scale = 0, int width = -1);
75
76 // Prints a percentage value. Values smaller than 1% but not 0 are displayed as "<1%", values
77 // larger than 99% but not 100% are displayed as ">100%".
78 void print_percentage(outputStream* st, size_t total, size_t part);
79
80 #ifdef ASSERT
81 #define assert_is_aligned(value, alignment) \
82 assert(is_aligned((value), (alignment)), \
83 SIZE_FORMAT_X " is not aligned to " \
84 SIZE_FORMAT_X, (size_t)(uintptr_t)value, (size_t)(alignment))
85 #define assert_is_aligned_metaspace_pointer(p) \
86 assert_is_aligned((p), metaspace::AllocationAlignmentByteSize);
87 #else
88 #define assert_is_aligned(value, alignment)
89 #define assert_is_aligned_metaspace_pointer(pointer)
90 #endif
91
92 // Pretty printing helpers
93 const char* classes_plural(uintx num);
94 const char* loaders_plural(uintx num);
95 void print_number_of_classes(outputStream* out, uintx classes, uintx classes_shared);
96
97 // Since Metaspace verifications are expensive, we want to do them at a reduced rate,
98 // but not completely avoiding them.
99 // For that we introduce the macros SOMETIMES() and ASSERT_SOMETIMES() which will
100 // execute code or assert at intervals controlled via VerifyMetaspaceInterval.
101 #ifdef ASSERT
102
103 #define EVERY_NTH(n) \
104 { static int counter_ = 0; \
105 if (n > 0) { \
106 counter_++; \
107 if (counter_ >= n) { \
108 counter_ = 0; \
109
110 #define END_EVERY_NTH } } }
111
112 #define SOMETIMES(code) \
113 EVERY_NTH(VerifyMetaspaceInterval) \
114 { code } \
115 END_EVERY_NTH
116
117 #define ASSERT_SOMETIMES(condition, ...) \
118 EVERY_NTH(VerifyMetaspaceInterval) \
119 assert( (condition), __VA_ARGS__); \
120 END_EVERY_NTH
121
122 #else
123
124 #define SOMETIMES(code)
125 #define ASSERT_SOMETIMES(condition, ...)
126
127 #endif // ASSERT
128
129 ///////// Logging //////////////
130
131 // What we log at which levels:
132
133 // "info" : metaspace failed allocation, commit failure, reserve failure, metaspace oom, metaspace gc threshold changed, Arena created, destroyed, metaspace purged
134
135 // "debug" : "info" + vslist extended, memory committed/uncommitted, chunk created/split/merged/enlarged, chunk returned
136
137 // "trace" : "debug" + every single allocation and deallocation, internals
138
139 #define HAVE_UL
140
141 #ifdef HAVE_UL
142 #define UL(level, message) log_##level(metaspace)(LOGFMT ": " message, LOGFMT_ARGS);
143 #define UL2(level, message, ...) log_##level(metaspace)(LOGFMT ": " message, LOGFMT_ARGS, __VA_ARGS__);
144 #else
145 #define UL(level, ...)
146 #define UL2(level, ...)
147 #endif
148
149 } // namespace metaspace
150
151 #endif // SHARE_MEMORY_METASPACE_METASPACECOMMON_HPP