1 /*
2 * Copyright (c) 2018, 2019, Red Hat, Inc. All rights reserved.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation.
7 *
8 * This code is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11 * version 2 for more details (a copy is included in the LICENSE file that
12 * accompanied this code).
13 *
14 * You should have received a copy of the GNU General Public License version
15 * 2 along with this work; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
17 *
18 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
19 * or visit www.oracle.com if you need additional information or have any
20 * questions.
21 *
22 */
23
24 #ifndef SHARE_GC_SHENANDOAH_SHENANDOAHASSERTS_HPP
25 #define SHARE_GC_SHENANDOAH_SHENANDOAHASSERTS_HPP
26
27 #include "memory/iterator.hpp"
28 #include "runtime/mutex.hpp"
29 #include "utilities/formatBuffer.hpp"
30
31 typedef FormatBuffer<8192> ShenandoahMessageBuffer;
32
33 class ShenandoahAsserts {
34 public:
35 enum SafeLevel {
36 _safe_unknown,
37 _safe_oop,
38 _safe_oop_fwd,
39 _safe_all
40 };
41
42 static void print_obj(ShenandoahMessageBuffer &msg, oop obj);
43
44 static void print_non_obj(ShenandoahMessageBuffer &msg, void *loc);
45
46 static void print_obj_safe(ShenandoahMessageBuffer &msg, void *loc);
47
48 static void print_failure(SafeLevel level, oop obj, void *interior_loc, oop loc,
49 const char *phase, const char *label,
50 const char *file, int line);
51
52 static void print_rp_failure(const char *label, BoolObjectClosure* actual,
53 const char *file, int line);
54
55 static void assert_in_heap(void* interior_loc, oop obj, const char* file, int line);
56 static void assert_in_correct_region(void* interior_loc, oop obj, const char* file, int line);
57
58 static void assert_correct(void* interior_loc, oop obj, const char* file, int line);
59 static void assert_forwarded(void* interior_loc, oop obj, const char* file, int line);
60 static void assert_not_forwarded(void* interior_loc, oop obj, const char* file, int line);
61 static void assert_marked(void* interior_loc, oop obj, const char* file, int line);
62 static void assert_in_cset(void* interior_loc, oop obj, const char* file, int line);
63 static void assert_not_in_cset(void* interior_loc, oop obj, const char* file, int line);
64 static void assert_not_in_cset_loc(void* interior_loc, const char* file, int line);
65
66 static void assert_rp_isalive_not_installed(const char *file, int line);
67 static void assert_rp_isalive_installed(const char *file, int line);
68
69 static void assert_locked_or_shenandoah_safepoint(Mutex* lock, const char* file, int line);
70
71 #ifdef ASSERT
72 // Shenandoah uses oop's marked pattern to indicate forwarding. Unfortunately, ObjectMarker (jvmtiTagMap.cpp)
73 // also uses this pattern to indicate visited.
74 // In ObjectMarker's destructor, it invokes heap iteration to reset the marked bits to their original values.
75 // That trips over many assertions on heap iteration code paths, but there are invariants:
76 // 1. Marked pattern in collection set indicates forwarding
77 // 2. Marked pattern off collection set indicates visited by ObjectMarker (because oops seen by
78 // ObjectMarker were LRB'd)
79 // 3. No off collection set marked pattern at any shenandoah safepoint. In fact, no off collection set
80 // marked pattern at any safepoints other than VM_HeapWalkOperation safepoints.
81 // This is an important invariant, since traversal degenerated GC clears collection set before
82 // entering degenerated GC cycle.
83 // So, we will need temporary disable assertions for oops with marked pattern outside collection set.
84 // Note: We only enforce this check for debug assertion to preserve full capacities of verifier,
85 // because verifier always runs at safepoints.
86 static bool can_verify_oop(oop obj);
87
88 #define shenandoah_assert_in_heap(interior_loc, obj) \
89 if (ShenandoahAsserts::can_verify_oop(obj)) \
90 ShenandoahAsserts::assert_in_heap(interior_loc, obj, __FILE__, __LINE__);
91 #define shenandoah_assert_in_correct_region(interior_loc, obj) \
92 if (ShenandoahAsserts::can_verify_oop(obj)) \
93 ShenandoahAsserts::assert_in_correct_region(interior_loc, obj, __FILE__, __LINE__);
94
95 #define shenandoah_assert_correct_if(interior_loc, obj, condition) \
96 if (condition && ShenandoahAsserts::can_verify_oop(obj)) ShenandoahAsserts::assert_correct(interior_loc, obj, __FILE__, __LINE__);
97 #define shenandoah_assert_correct_except(interior_loc, obj, exception) \
98 if (!(exception) && ShenandoahAsserts::can_verify_oop(obj)) ShenandoahAsserts::assert_correct(interior_loc, obj, __FILE__, __LINE__);
99 #define shenandoah_assert_correct(interior_loc, obj) \
100 if (ShenandoahAsserts::can_verify_oop(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::can_verify_oop(obj)) ShenandoahAsserts::assert_forwarded(interior_loc, obj, __FILE__, __LINE__);
105 #define shenandoah_assert_forwarded_except(interior_loc, obj, exception) \
106 if (!(exception) && ShenandoahAsserts::can_verify_oop(obj)) ShenandoahAsserts::assert_forwarded(interior_loc, obj, __FILE__, __LINE__);
107 #define shenandoah_assert_forwarded(interior_loc, obj) \
108 if (ShenandoahAsserts::can_verify_oop(obj)) \
109 ShenandoahAsserts::assert_forwarded(interior_loc, obj, __FILE__, __LINE__);
110
111 #define shenandoah_assert_not_forwarded_if(interior_loc, obj, condition) \
112 if (condition && ShenandoahAsserts::can_verify_oop(obj)) ShenandoahAsserts::assert_not_forwarded(interior_loc, obj, __FILE__, __LINE__);
113 #define shenandoah_assert_not_forwarded_except(interior_loc, obj, exception) \
114 if (!(exception) && ShenandoahAsserts::can_verify_oop(obj)) ShenandoahAsserts::assert_not_forwarded(interior_loc, obj, __FILE__, __LINE__);
115 #define shenandoah_assert_not_forwarded(interior_loc, obj) \
116 if (ShenandoahAsserts::can_verify_oop(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::can_verify_oop(obj)) ShenandoahAsserts::assert_marked(interior_loc, obj, __FILE__, __LINE__);
121 #define shenandoah_assert_marked_except(interior_loc, obj, exception) \
122 if (!(exception) && ShenandoahAsserts::can_verify_oop(obj)) ShenandoahAsserts::assert_marked(interior_loc, obj, __FILE__, __LINE__);
123 #define shenandoah_assert_marked(interior_loc, obj) \
124 if (ShenandoahAsserts::can_verify_oop(obj)) \
125 ShenandoahAsserts::assert_marked(interior_loc, obj, __FILE__, __LINE__);
126
127 #define shenandoah_assert_in_cset_if(interior_loc, obj, condition) \
128 if (condition && ShenandoahAsserts::can_verify_oop(obj)) ShenandoahAsserts::assert_in_cset(interior_loc, obj, __FILE__, __LINE__);
129 #define shenandoah_assert_in_cset_except(interior_loc, obj, exception) \
130 if (!(exception) && ShenandoahAsserts::can_verify_oop(obj)) ShenandoahAsserts::assert_in_cset(interior_loc, obj, __FILE__, __LINE__);
131 #define shenandoah_assert_in_cset(interior_loc, obj) \
132 if (ShenandoahAsserts::can_verify_oop(obj)) \
133 ShenandoahAsserts::assert_in_cset(interior_loc, obj, __FILE__, __LINE__);
134
135 #define shenandoah_assert_not_in_cset_if(interior_loc, obj, condition) \
136 if (condition && ShenandoahAsserts::can_verify_oop(obj)) ShenandoahAsserts::assert_not_in_cset(interior_loc, obj, __FILE__, __LINE__);
137 #define shenandoah_assert_not_in_cset_except(interior_loc, obj, exception) \
138 if (!(exception) && ShenandoahAsserts::can_verify_oop(obj)) ShenandoahAsserts::assert_not_in_cset(interior_loc, obj, __FILE__, __LINE__);
139 #define shenandoah_assert_not_in_cset(interior_loc, obj) \
140 if (ShenandoahAsserts::can_verify_oop(obj)) \
141 ShenandoahAsserts::assert_not_in_cset(interior_loc, obj, __FILE__, __LINE__);
142
143 #define shenandoah_assert_not_in_cset_loc_if(interior_loc, condition) \
144 if (condition) ShenandoahAsserts::assert_not_in_cset_loc(interior_loc, __FILE__, __LINE__);
145 #define shenandoah_assert_not_in_cset_loc_except(interior_loc, exception) \
146 if (!(exception)) ShenandoahAsserts::assert_not_in_cset_loc(interior_loc, __FILE__, __LINE__);
147 #define shenandoah_assert_not_in_cset_loc(interior_loc) \
148 ShenandoahAsserts::assert_not_in_cset_loc(interior_loc, __FILE__, __LINE__);
149
150 #define shenandoah_assert_rp_isalive_installed() \
151 ShenandoahAsserts::assert_rp_isalive_installed(__FILE__, __LINE__);
152 #define shenandoah_assert_rp_isalive_not_installed() \
153 ShenandoahAsserts::assert_rp_isalive_not_installed(__FILE__, __LINE__);
154
155 #define shenandoah_assert_safepoint() \
156 assert(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "Should be at Shenandoah Safepoints");
157
158 #define shenandoah_assert_locked_or_safepoint(lock) \
159 ShenandoahAsserts::assert_locked_or_shenandoah_safepoint(lock, __FILE__, __LINE__);
160 #else
161 #define shenandoah_assert_in_heap(interior_loc, obj)
162 #define shenandoah_assert_in_correct_region(interior_loc, obj)
163
164 #define shenandoah_assert_correct_if(interior_loc, obj, condition)
165 #define shenandoah_assert_correct_except(interior_loc, obj, exception)
166 #define shenandoah_assert_correct(interior_loc, obj)
167
168 #define shenandoah_assert_forwarded_if(interior_loc, obj, condition)
169 #define shenandoah_assert_forwarded_except(interior_loc, obj, exception)
170 #define shenandoah_assert_forwarded(interior_loc, obj)
171
172 #define shenandoah_assert_not_forwarded_if(interior_loc, obj, condition)
173 #define shenandoah_assert_not_forwarded_except(interior_loc, obj, exception)
174 #define shenandoah_assert_not_forwarded(interior_loc, obj)
175
176 #define shenandoah_assert_marked_if(interior_loc, obj, condition)
177 #define shenandoah_assert_marked_except(interior_loc, obj, exception)
178 #define shenandoah_assert_marked(interior_loc, obj)
179
180 #define shenandoah_assert_in_cset_if(interior_loc, obj, condition)
181 #define shenandoah_assert_in_cset_except(interior_loc, obj, exception)
182 #define shenandoah_assert_in_cset(interior_loc, obj)
183
184 #define shenandoah_assert_not_in_cset_if(interior_loc, obj, condition)
185 #define shenandoah_assert_not_in_cset_except(interior_loc, obj, exception)
186 #define shenandoah_assert_not_in_cset(interior_loc, obj)
187
188 #define shenandoah_assert_not_in_cset_loc_if(interior_loc, condition)
189 #define shenandoah_assert_not_in_cset_loc_except(interior_loc, exception)
190 #define shenandoah_assert_not_in_cset_loc(interior_loc)
191
192 #define shenandoah_assert_rp_isalive_installed()
193 #define shenandoah_assert_rp_isalive_not_installed()
194
195 #define shenandoah_assert_safepoint()
196 #define shenandoah_assert_locked_or_safepoint(lock)
197
198 #endif
199
200 #define shenandoah_not_implemented \
201 { fatal("Deliberately not implemented."); }
202 #define shenandoah_not_implemented_return(v) \
203 { fatal("Deliberately not implemented."); return v; }
204
205 };
206
207 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHASSERTS_HPP