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