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