1 /*
2 * Copyright (c) 2018, 2025, Red Hat, Inc. All rights reserved.
3 * Copyright Amazon.com Inc. or its affiliates. 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_GC_SHENANDOAH_SHENANDOAHASSERTS_HPP
27 #define SHARE_GC_SHENANDOAH_SHENANDOAHASSERTS_HPP
28
29 #include "memory/iterator.hpp"
30 #include "oops/compressedKlass.hpp"
31 #include "runtime/mutex.hpp"
32 #include "utilities/formatBuffer.hpp"
33
34 typedef FormatBuffer<8192> ShenandoahMessageBuffer;
35
36 class ShenandoahAsserts {
37 public:
38 enum SafeLevel {
39 _safe_unknown,
40 _safe_oop,
41 _safe_oop_fwd,
42 _safe_all
43 };
44
45 static void print_obj(ShenandoahMessageBuffer &msg, oop obj);
46
47 static void print_non_obj(ShenandoahMessageBuffer &msg, void *loc);
48
49 static void print_obj_safe(ShenandoahMessageBuffer &msg, void *loc);
50
51 static void print_failure(SafeLevel level, oop obj, void *interior_loc, oop loc,
52 const char *phase, const char *label,
53 const char *file, int line);
54
55 static void print_rp_failure(const char *label, BoolObjectClosure* actual,
56 const char *file, int line);
57
58 static void assert_in_heap_bounds(void* interior_loc, oop obj, const char* file, int line);
59 static void assert_in_heap_bounds_or_null(void* interior_loc, oop obj, const char* file, int line);
60 static void assert_in_correct_region(void* interior_loc, oop obj, const char* file, int line);
61
62 static void assert_correct(void* interior_loc, oop obj, const char* file, int line);
63 static void assert_forwarded(void* interior_loc, oop obj, const char* file, int line);
64 static void assert_not_forwarded(void* interior_loc, oop obj, const char* file, int line);
65 static void assert_marked(void* interior_loc, oop obj, const char* file, int line);
66 static void assert_marked_weak(void* interior_loc, oop obj, const char* file, int line);
67 static void assert_marked_strong(void* interior_loc, oop obj, const char* file, int line);
68
69 // Assert that marking is complete for the generation where this obj resides
70 static void assert_mark_complete(HeapWord* obj, const char* file, int line);
71 static void assert_in_cset(void* interior_loc, oop obj, const char* file, int line);
72 static void assert_not_in_cset(void* interior_loc, oop obj, const char* file, int line);
73 static void assert_not_in_cset_loc(void* interior_loc, const char* file, int line);
74
75 static void assert_locked_or_shenandoah_safepoint(Mutex* lock, const char* file, int line);
76
77 static void assert_heaplocked(const char* file, int line);
78 static void assert_not_heaplocked(const char* file, int line);
79 static void assert_heaplocked_or_safepoint(const char* file, int line);
80 static void assert_control_or_vm_thread_at_safepoint(bool at_safepoint, const char* file, int line);
81 static void assert_generational(const char* file, int line);
82
83 static void assert_in_young(void* interior_loc, oop obj, const char* file, int line);
84
85 // Given a possibly invalid oop, extract narrowKlass (if UCCP) and Klass*
86 // from it safely.
87 // Note: For -UCCP, returned nk is always 0.
88 static bool extract_klass_safely(oop obj, narrowKlass& nk, const Klass*& k);
89
90 #ifdef ASSERT
91 #define shenandoah_assert_in_heap_bounds(interior_loc, obj) \
92 ShenandoahAsserts::assert_in_heap_bounds(interior_loc, obj, __FILE__, __LINE__)
93 #define shenandoah_assert_in_heap_bounds_or_null(interior_loc, obj) \
94 ShenandoahAsserts::assert_in_heap_bounds_or_null(interior_loc, obj, __FILE__, __LINE__)
95 #define shenandoah_assert_in_correct_region(interior_loc, obj) \
96 ShenandoahAsserts::assert_in_correct_region(interior_loc, obj, __FILE__, __LINE__)
97
98 #define shenandoah_assert_correct_if(interior_loc, obj, condition) \
99 if (condition) ShenandoahAsserts::assert_correct(interior_loc, obj, __FILE__, __LINE__)
100 #define shenandoah_assert_correct_except(interior_loc, obj, exception) \
101 if (!(exception)) ShenandoahAsserts::assert_correct(interior_loc, obj, __FILE__, __LINE__)
102 #define shenandoah_assert_correct(interior_loc, obj) \
103 ShenandoahAsserts::assert_correct(interior_loc, obj, __FILE__, __LINE__)
104
105 #define shenandoah_assert_forwarded_if(interior_loc, obj, condition) \
106 if (condition) ShenandoahAsserts::assert_forwarded(interior_loc, obj, __FILE__, __LINE__)
107 #define shenandoah_assert_forwarded_except(interior_loc, obj, exception) \
108 if (!(exception)) ShenandoahAsserts::assert_forwarded(interior_loc, obj, __FILE__, __LINE__)
109 #define shenandoah_assert_forwarded(interior_loc, obj) \
110 ShenandoahAsserts::assert_forwarded(interior_loc, obj, __FILE__, __LINE__)
111
112 #define shenandoah_assert_not_forwarded_if(interior_loc, obj, condition) \
113 if (condition) ShenandoahAsserts::assert_not_forwarded(interior_loc, obj, __FILE__, __LINE__)
114 #define shenandoah_assert_not_forwarded_except(interior_loc, obj, exception) \
115 if (!(exception)) ShenandoahAsserts::assert_not_forwarded(interior_loc, obj, __FILE__, __LINE__)
116 #define shenandoah_assert_not_forwarded(interior_loc, obj) \
117 ShenandoahAsserts::assert_not_forwarded(interior_loc, obj, __FILE__, __LINE__)
118
119 #define shenandoah_assert_marked_if(interior_loc, obj, condition) \
120 if (condition) ShenandoahAsserts::assert_marked(interior_loc, obj, __FILE__, __LINE__)
121 #define shenandoah_assert_marked_except(interior_loc, obj, exception) \
122 if (!(exception)) ShenandoahAsserts::assert_marked(interior_loc, obj, __FILE__, __LINE__)
123 #define shenandoah_assert_marked(interior_loc, obj) \
124 ShenandoahAsserts::assert_marked(interior_loc, obj, __FILE__, __LINE__)
125
126 #define shenandoah_assert_marked_weak_if(interior_loc, obj, condition) \
127 if (condition) ShenandoahAsserts::assert_marked_weak(interior_loc, obj, __FILE__, __LINE__)
128 #define shenandoah_assert_marked_weak_except(interior_loc, obj, exception) \
129 if (!(exception)) ShenandoahAsserts::assert_marked_weak(interior_loc, obj, __FILE__, __LINE__)
130 #define shenandoah_assert_marked_weak(interior_loc, obj) \
131 ShenandoahAsserts::assert_marked_weak(interior_loc, obj, __FILE__, __LINE__)
132
133 #define shenandoah_assert_marked_strong_if(interior_loc, obj, condition) \
134 if (condition) ShenandoahAsserts::assert_marked_strong(interior_loc, obj, __FILE__, __LINE__)
135 #define shenandoah_assert_marked_strong_except(interior_loc, obj, exception) \
136 if (!(exception)) ShenandoahAsserts::assert_marked_strong(interior_loc, obj, __FILE__, __LINE__)
137 #define shenandoah_assert_marked_strong(interior_loc, obj) \
138 ShenandoahAsserts::assert_marked_strong(interior_loc, obj, __FILE__, __LINE__)
139
140 #define shenandoah_assert_mark_complete(obj) \
141 ShenandoahAsserts::assert_mark_complete(obj, __FILE__, __LINE__)
142
143 #define shenandoah_assert_in_cset_if(interior_loc, obj, condition) \
144 if (condition) ShenandoahAsserts::assert_in_cset(interior_loc, obj, __FILE__, __LINE__)
145 #define shenandoah_assert_in_cset_except(interior_loc, obj, exception) \
146 if (!(exception)) ShenandoahAsserts::assert_in_cset(interior_loc, obj, __FILE__, __LINE__)
147 #define shenandoah_assert_in_cset(interior_loc, obj) \
148 ShenandoahAsserts::assert_in_cset(interior_loc, obj, __FILE__, __LINE__)
149
150 #define shenandoah_assert_not_in_cset_if(interior_loc, obj, condition) \
151 if (condition) ShenandoahAsserts::assert_not_in_cset(interior_loc, obj, __FILE__, __LINE__)
152 #define shenandoah_assert_not_in_cset_except(interior_loc, obj, exception) \
153 if (!(exception)) ShenandoahAsserts::assert_not_in_cset(interior_loc, obj, __FILE__, __LINE__)
154 #define shenandoah_assert_not_in_cset(interior_loc, obj) \
155 ShenandoahAsserts::assert_not_in_cset(interior_loc, obj, __FILE__, __LINE__)
156
157 #define shenandoah_assert_not_in_cset_loc_if(interior_loc, condition) \
158 if (condition) ShenandoahAsserts::assert_not_in_cset_loc(interior_loc, __FILE__, __LINE__)
159 #define shenandoah_assert_not_in_cset_loc_except(interior_loc, exception) \
160 if (!(exception)) ShenandoahAsserts::assert_not_in_cset_loc(interior_loc, __FILE__, __LINE__)
161 #define shenandoah_assert_not_in_cset_loc(interior_loc) \
162 ShenandoahAsserts::assert_not_in_cset_loc(interior_loc, __FILE__, __LINE__)
163
164 #define shenandoah_assert_in_young_if(interior_loc, obj, condition) \
165 if (condition) ShenandoahAsserts::assert_in_young(interior_loc, obj, __FILE__, __LINE__)
166 #define shenandoah_assert_in_young_except(interior_loc, obj, exception) \
167 if (!(exception)) ShenandoahAsserts::assert_in_young(interior_loc, obj, __FILE__, __LINE__)
168 #define shenandoah_assert_in_young(interior_loc, obj) \
169 ShenandoahAsserts::assert_in_young(interior_loc, obj, __FILE__, __LINE__)
170
171 #define shenandoah_assert_rp_isalive_installed() \
172 ShenandoahAsserts::assert_rp_isalive_installed(__FILE__, __LINE__)
173 #define shenandoah_assert_rp_isalive_not_installed() \
174 ShenandoahAsserts::assert_rp_isalive_not_installed(__FILE__, __LINE__)
175
176 #define shenandoah_assert_safepoint() \
177 assert(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "Should be at Shenandoah Safepoints")
178
179 #define shenandoah_assert_locked_or_safepoint(lock) \
180 ShenandoahAsserts::assert_locked_or_shenandoah_safepoint(lock, __FILE__, __LINE__)
181
182 #define shenandoah_assert_heaplocked() \
183 ShenandoahAsserts::assert_heaplocked(__FILE__, __LINE__)
184
185 #define shenandoah_assert_not_heaplocked() \
186 ShenandoahAsserts::assert_not_heaplocked(__FILE__, __LINE__)
187
188 #define shenandoah_assert_heaplocked_or_safepoint() \
189 ShenandoahAsserts::assert_heaplocked_or_safepoint(__FILE__, __LINE__)
190
191 #define shenandoah_assert_control_or_vm_thread() \
192 ShenandoahAsserts::assert_control_or_vm_thread(false /* at_safepoint */, __FILE__, __LINE__)
193
194 // A stronger version of the above that checks that we are at a safepoint if the vm thread
195 #define shenandoah_assert_control_or_vm_thread_at_safepoint() \
196 ShenandoahAsserts::assert_control_or_vm_thread_at_safepoint(true /* at_safepoint */, __FILE__, __LINE__)
197
198 #define shenandoah_assert_generational() \
199 ShenandoahAsserts::assert_generational(__FILE__, __LINE__)
200
201 #else
202 #define shenandoah_assert_in_heap_bounds(interior_loc, obj)
203 #define shenandoah_assert_in_heap_bounds_or_null(interior_loc, obj)
204 #define shenandoah_assert_in_correct_region(interior_loc, obj)
205
206 #define shenandoah_assert_correct_if(interior_loc, obj, condition)
207 #define shenandoah_assert_correct_except(interior_loc, obj, exception)
208 #define shenandoah_assert_correct(interior_loc, obj)
209
210 #define shenandoah_assert_forwarded_if(interior_loc, obj, condition)
211 #define shenandoah_assert_forwarded_except(interior_loc, obj, exception)
212 #define shenandoah_assert_forwarded(interior_loc, obj)
213
214 #define shenandoah_assert_not_forwarded_if(interior_loc, obj, condition)
215 #define shenandoah_assert_not_forwarded_except(interior_loc, obj, exception)
216 #define shenandoah_assert_not_forwarded(interior_loc, obj)
217
218 #define shenandoah_assert_marked_if(interior_loc, obj, condition)
219 #define shenandoah_assert_marked_except(interior_loc, obj, exception)
220 #define shenandoah_assert_marked(interior_loc, obj)
221
222 #define shenandoah_assert_marked_weak_if(interior_loc, obj, condition)
223 #define shenandoah_assert_marked_weak_except(interior_loc, obj, exception)
224 #define shenandoah_assert_marked_weak(interior_loc, obj)
225
226 #define shenandoah_assert_marked_strong_if(interior_loc, obj, condition)
227 #define shenandoah_assert_marked_strong_except(interior_loc, obj, exception)
228 #define shenandoah_assert_marked_strong(interior_loc, obj)
229
230 #define shenandoah_assert_mark_complete(obj)
231
232 #define shenandoah_assert_in_cset_if(interior_loc, obj, condition)
233 #define shenandoah_assert_in_cset_except(interior_loc, obj, exception)
234 #define shenandoah_assert_in_cset(interior_loc, obj)
235
236 #define shenandoah_assert_not_in_cset_if(interior_loc, obj, condition)
237 #define shenandoah_assert_not_in_cset_except(interior_loc, obj, exception)
238 #define shenandoah_assert_not_in_cset(interior_loc, obj)
239
240 #define shenandoah_assert_not_in_cset_loc_if(interior_loc, condition)
241 #define shenandoah_assert_not_in_cset_loc_except(interior_loc, exception)
242 #define shenandoah_assert_not_in_cset_loc(interior_loc)
243
244 #define shenandoah_assert_rp_isalive_installed()
245 #define shenandoah_assert_rp_isalive_not_installed()
246
247 #define shenandoah_assert_safepoint()
248 #define shenandoah_assert_locked_or_safepoint(lock)
249
250 #define shenandoah_assert_heaplocked()
251 #define shenandoah_assert_not_heaplocked()
252 #define shenandoah_assert_heaplocked_or_safepoint()
253 #define shenandoah_assert_control_or_vm_thread()
254 #define shenandoah_assert_control_or_vm_thread_at_safepoint()
255 #define shenandoah_assert_generational()
256
257 #define shenandoah_assert_in_young_if(interior_loc, obj, condition)
258 #define shenandoah_assert_in_young_except(interior_loc, obj, exception)
259 #define shenandoah_assert_in_young(interior_loc, obj)
260
261 #endif
262
263 #define shenandoah_not_implemented \
264 { fatal("Deliberately not implemented."); }
265 #define shenandoah_not_implemented_return(v) \
266 { fatal("Deliberately not implemented."); return v; }
267
268 };
269
270 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHASSERTS_HPP