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 // Given a possibly invalid oop, extract narrowKlass (if UCCP) and Klass*
84 // from it safely.
85 // Note: For -UCCP, returned nk is always 0.
86 static bool extract_klass_safely(oop obj, narrowKlass& nk, const Klass*& k);
87
88 #ifdef ASSERT
89 #define shenandoah_assert_in_heap_bounds(interior_loc, obj) \
90 ShenandoahAsserts::assert_in_heap_bounds(interior_loc, obj, __FILE__, __LINE__)
91 #define shenandoah_assert_in_heap_bounds_or_null(interior_loc, obj) \
92 ShenandoahAsserts::assert_in_heap_bounds_or_null(interior_loc, obj, __FILE__, __LINE__)
93 #define shenandoah_assert_in_correct_region(interior_loc, obj) \
94 ShenandoahAsserts::assert_in_correct_region(interior_loc, obj, __FILE__, __LINE__)
95
96 #define shenandoah_assert_correct_if(interior_loc, obj, condition) \
97 if (condition) ShenandoahAsserts::assert_correct(interior_loc, obj, __FILE__, __LINE__)
98 #define shenandoah_assert_correct_except(interior_loc, obj, exception) \
99 if (!(exception)) ShenandoahAsserts::assert_correct(interior_loc, obj, __FILE__, __LINE__)
100 #define shenandoah_assert_correct(interior_loc, obj) \
101 ShenandoahAsserts::assert_correct(interior_loc, obj, __FILE__, __LINE__)
102
103 #define shenandoah_assert_forwarded_if(interior_loc, obj, condition) \
104 if (condition) ShenandoahAsserts::assert_forwarded(interior_loc, obj, __FILE__, __LINE__)
105 #define shenandoah_assert_forwarded_except(interior_loc, obj, exception) \
106 if (!(exception)) ShenandoahAsserts::assert_forwarded(interior_loc, obj, __FILE__, __LINE__)
107 #define shenandoah_assert_forwarded(interior_loc, obj) \
108 ShenandoahAsserts::assert_forwarded(interior_loc, obj, __FILE__, __LINE__)
109
110 #define shenandoah_assert_not_forwarded_if(interior_loc, obj, condition) \
111 if (condition) ShenandoahAsserts::assert_not_forwarded(interior_loc, obj, __FILE__, __LINE__)
112 #define shenandoah_assert_not_forwarded_except(interior_loc, obj, exception) \
113 if (!(exception)) ShenandoahAsserts::assert_not_forwarded(interior_loc, obj, __FILE__, __LINE__)
114 #define shenandoah_assert_not_forwarded(interior_loc, obj) \
115 ShenandoahAsserts::assert_not_forwarded(interior_loc, obj, __FILE__, __LINE__)
116
117 #define shenandoah_assert_marked_if(interior_loc, obj, condition) \
118 if (condition) ShenandoahAsserts::assert_marked(interior_loc, obj, __FILE__, __LINE__)
119 #define shenandoah_assert_marked_except(interior_loc, obj, exception) \
120 if (!(exception)) ShenandoahAsserts::assert_marked(interior_loc, obj, __FILE__, __LINE__)
121 #define shenandoah_assert_marked(interior_loc, obj) \
122 ShenandoahAsserts::assert_marked(interior_loc, obj, __FILE__, __LINE__)
123
124 #define shenandoah_assert_marked_weak_if(interior_loc, obj, condition) \
125 if (condition) ShenandoahAsserts::assert_marked_weak(interior_loc, obj, __FILE__, __LINE__)
126 #define shenandoah_assert_marked_weak_except(interior_loc, obj, exception) \
127 if (!(exception)) ShenandoahAsserts::assert_marked_weak(interior_loc, obj, __FILE__, __LINE__)
128 #define shenandoah_assert_marked_weak(interior_loc, obj) \
129 ShenandoahAsserts::assert_marked_weak(interior_loc, obj, __FILE__, __LINE__)
130
131 #define shenandoah_assert_marked_strong_if(interior_loc, obj, condition) \
132 if (condition) ShenandoahAsserts::assert_marked_strong(interior_loc, obj, __FILE__, __LINE__)
133 #define shenandoah_assert_marked_strong_except(interior_loc, obj, exception) \
134 if (!(exception)) ShenandoahAsserts::assert_marked_strong(interior_loc, obj, __FILE__, __LINE__)
135 #define shenandoah_assert_marked_strong(interior_loc, obj) \
136 ShenandoahAsserts::assert_marked_strong(interior_loc, obj, __FILE__, __LINE__)
137
138 #define shenandoah_assert_mark_complete(obj) \
139 ShenandoahAsserts::assert_mark_complete(obj, __FILE__, __LINE__)
140
141 #define shenandoah_assert_in_cset_if(interior_loc, obj, condition) \
142 if (condition) ShenandoahAsserts::assert_in_cset(interior_loc, obj, __FILE__, __LINE__)
143 #define shenandoah_assert_in_cset_except(interior_loc, obj, exception) \
144 if (!(exception)) ShenandoahAsserts::assert_in_cset(interior_loc, obj, __FILE__, __LINE__)
145 #define shenandoah_assert_in_cset(interior_loc, obj) \
146 ShenandoahAsserts::assert_in_cset(interior_loc, obj, __FILE__, __LINE__)
147
148 #define shenandoah_assert_not_in_cset_if(interior_loc, obj, condition) \
149 if (condition) ShenandoahAsserts::assert_not_in_cset(interior_loc, obj, __FILE__, __LINE__)
150 #define shenandoah_assert_not_in_cset_except(interior_loc, obj, exception) \
151 if (!(exception)) ShenandoahAsserts::assert_not_in_cset(interior_loc, obj, __FILE__, __LINE__)
152 #define shenandoah_assert_not_in_cset(interior_loc, obj) \
153 ShenandoahAsserts::assert_not_in_cset(interior_loc, obj, __FILE__, __LINE__)
154
155 #define shenandoah_assert_not_in_cset_loc_if(interior_loc, condition) \
156 if (condition) ShenandoahAsserts::assert_not_in_cset_loc(interior_loc, __FILE__, __LINE__)
157 #define shenandoah_assert_not_in_cset_loc_except(interior_loc, exception) \
158 if (!(exception)) ShenandoahAsserts::assert_not_in_cset_loc(interior_loc, __FILE__, __LINE__)
159 #define shenandoah_assert_not_in_cset_loc(interior_loc) \
160 ShenandoahAsserts::assert_not_in_cset_loc(interior_loc, __FILE__, __LINE__)
161
162 #define shenandoah_assert_rp_isalive_installed() \
163 ShenandoahAsserts::assert_rp_isalive_installed(__FILE__, __LINE__)
164 #define shenandoah_assert_rp_isalive_not_installed() \
165 ShenandoahAsserts::assert_rp_isalive_not_installed(__FILE__, __LINE__)
166
167 #define shenandoah_assert_safepoint() \
168 assert(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "Should be at Shenandoah Safepoints")
169
170 #define shenandoah_assert_locked_or_safepoint(lock) \
171 ShenandoahAsserts::assert_locked_or_shenandoah_safepoint(lock, __FILE__, __LINE__)
172
173 #define shenandoah_assert_heaplocked() \
174 ShenandoahAsserts::assert_heaplocked(__FILE__, __LINE__)
175
176 #define shenandoah_assert_not_heaplocked() \
177 ShenandoahAsserts::assert_not_heaplocked(__FILE__, __LINE__)
178
179 #define shenandoah_assert_heaplocked_or_safepoint() \
180 ShenandoahAsserts::assert_heaplocked_or_safepoint(__FILE__, __LINE__)
181
182 #define shenandoah_assert_control_or_vm_thread() \
183 ShenandoahAsserts::assert_control_or_vm_thread(false /* at_safepoint */, __FILE__, __LINE__)
184
185 // A stronger version of the above that checks that we are at a safepoint if the vm thread
186 #define shenandoah_assert_control_or_vm_thread_at_safepoint() \
187 ShenandoahAsserts::assert_control_or_vm_thread_at_safepoint(true /* at_safepoint */, __FILE__, __LINE__)
188
189 #define shenandoah_assert_generational() \
190 ShenandoahAsserts::assert_generational(__FILE__, __LINE__)
191
192 #else
193 #define shenandoah_assert_in_heap_bounds(interior_loc, obj)
194 #define shenandoah_assert_in_heap_bounds_or_null(interior_loc, obj)
195 #define shenandoah_assert_in_correct_region(interior_loc, obj)
196
197 #define shenandoah_assert_correct_if(interior_loc, obj, condition)
198 #define shenandoah_assert_correct_except(interior_loc, obj, exception)
199 #define shenandoah_assert_correct(interior_loc, obj)
200
201 #define shenandoah_assert_forwarded_if(interior_loc, obj, condition)
202 #define shenandoah_assert_forwarded_except(interior_loc, obj, exception)
203 #define shenandoah_assert_forwarded(interior_loc, obj)
204
205 #define shenandoah_assert_not_forwarded_if(interior_loc, obj, condition)
206 #define shenandoah_assert_not_forwarded_except(interior_loc, obj, exception)
207 #define shenandoah_assert_not_forwarded(interior_loc, obj)
208
209 #define shenandoah_assert_marked_if(interior_loc, obj, condition)
210 #define shenandoah_assert_marked_except(interior_loc, obj, exception)
211 #define shenandoah_assert_marked(interior_loc, obj)
212
213 #define shenandoah_assert_marked_weak_if(interior_loc, obj, condition)
214 #define shenandoah_assert_marked_weak_except(interior_loc, obj, exception)
215 #define shenandoah_assert_marked_weak(interior_loc, obj)
216
217 #define shenandoah_assert_marked_strong_if(interior_loc, obj, condition)
218 #define shenandoah_assert_marked_strong_except(interior_loc, obj, exception)
219 #define shenandoah_assert_marked_strong(interior_loc, obj)
220
221 #define shenandoah_assert_mark_complete(obj)
222
223 #define shenandoah_assert_in_cset_if(interior_loc, obj, condition)
224 #define shenandoah_assert_in_cset_except(interior_loc, obj, exception)
225 #define shenandoah_assert_in_cset(interior_loc, obj)
226
227 #define shenandoah_assert_not_in_cset_if(interior_loc, obj, condition)
228 #define shenandoah_assert_not_in_cset_except(interior_loc, obj, exception)
229 #define shenandoah_assert_not_in_cset(interior_loc, obj)
230
231 #define shenandoah_assert_not_in_cset_loc_if(interior_loc, condition)
232 #define shenandoah_assert_not_in_cset_loc_except(interior_loc, exception)
233 #define shenandoah_assert_not_in_cset_loc(interior_loc)
234
235 #define shenandoah_assert_rp_isalive_installed()
236 #define shenandoah_assert_rp_isalive_not_installed()
237
238 #define shenandoah_assert_safepoint()
239 #define shenandoah_assert_locked_or_safepoint(lock)
240
241 #define shenandoah_assert_heaplocked()
242 #define shenandoah_assert_not_heaplocked()
243 #define shenandoah_assert_heaplocked_or_safepoint()
244 #define shenandoah_assert_control_or_vm_thread()
245 #define shenandoah_assert_control_or_vm_thread_at_safepoint()
246 #define shenandoah_assert_generational()
247
248 #endif
249
250 #define shenandoah_not_implemented \
251 { fatal("Deliberately not implemented."); }
252 #define shenandoah_not_implemented_return(v) \
253 { fatal("Deliberately not implemented."); return v; }
254
255 };
256
257 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHASSERTS_HPP