1 /*
2 * Copyright (c) 2013, 2015, Red Hat, Inc. and/or its affiliates.
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_VM_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP
25 #define SHARE_VM_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP
26
27 #include "gc/shared/accessBarrierSupport.hpp"
28 #include "gc/shared/barrierSet.hpp"
29 #include "gc/shenandoah/shenandoahHeap.hpp"
30 #include "gc/shenandoah/shenandoahSATBMarkQueueSet.hpp"
31
32 class ShenandoahBarrierSet: public BarrierSet {
33 private:
34
35 enum ArrayCopyStoreValMode {
36 NONE,
37 READ_BARRIER,
38 WRITE_BARRIER
39 };
40
41 static ShenandoahSATBMarkQueueSet _satb_mark_queue_set;
42
43 ShenandoahHeap* _heap;
44
45 public:
46
47 ShenandoahBarrierSet(ShenandoahHeap* heap);
48
49 inline static ShenandoahBarrierSet* barrier_set() {
50 return barrier_set_cast<ShenandoahBarrierSet>(BarrierSet::barrier_set());
51 }
52
53 static SATBMarkQueueSet& satb_mark_queue_set() {
54 return _satb_mark_queue_set;
55 }
56
57 void print_on(outputStream* st) const;
58
59 bool is_a(BarrierSet::Name bsn);
60
61 bool is_aligned(HeapWord* hw);
62 void resize_covered_region(MemRegion mr);
63
64 void write_ref_array(HeapWord* start, size_t count);
65 void write_ref_array_work(MemRegion r);
66
67 template <class T> void
68 write_ref_array_pre_work(T* dst, size_t count);
69
70 void write_ref_array_pre(oop* dst, size_t count, bool dest_uninitialized);
71
72 void write_ref_array_pre(narrowOop* dst, size_t count, bool dest_uninitialized);
73
74
75 // We export this to make it available in cases where the static
76 // type of the barrier set is known. Note that it is non-virtual.
77 template <class T> inline void inline_write_ref_field_pre(T* field, oop new_val);
78
79 // These are the more general virtual versions.
80 void write_ref_field_pre_work(oop* field, oop new_val);
81 void write_ref_field_pre_work(narrowOop* field, oop new_val);
82 void write_ref_field_pre_work(void* field, oop new_val);
83
84 void write_ref_field_work(void* v, oop o, bool release = false);
85 void write_region(MemRegion mr);
86
87 virtual void on_thread_create(Thread* thread);
88 virtual void on_thread_destroy(Thread* thread);
89 virtual void on_thread_attach(JavaThread* thread);
90 virtual void on_thread_detach(JavaThread* thread);
91
92 virtual oop read_barrier(oop src);
93
94 static inline oop resolve_forwarded_not_null(oop p);
95 static inline oop resolve_forwarded(oop p);
96
97 virtual oop write_barrier(oop obj);
98
99 virtual oop storeval_barrier(oop obj);
100
101 virtual void keep_alive_barrier(oop obj);
102
103 bool obj_equals(oop obj1, oop obj2);
104
105 void enqueue(oop obj);
106
107 private:
108 inline bool need_update_refs_barrier();
109
110 template <class T, bool UPDATE_MATRIX, bool STOREVAL_WRITE_BARRIER>
111 void write_ref_array_loop(HeapWord* start, size_t count);
112
113 oop write_barrier_impl(oop obj);
114
115 static void keep_alive_if_weak(DecoratorSet decorators, oop value) {
116 assert((decorators & ON_UNKNOWN_OOP_REF) == 0, "Reference strength must be known");
117 const bool on_strong_oop_ref = (decorators & ON_STRONG_OOP_REF) != 0;
118 const bool peek = (decorators & AS_NO_KEEPALIVE) != 0;
119 if (!peek && !on_strong_oop_ref && value != NULL) {
120 ShenandoahBarrierSet::barrier_set()->keep_alive_barrier(value);
121 }
122 }
123
124 template <typename T>
125 bool arraycopy_loop_1(T* src, T* dst, size_t length, Klass* bound,
126 bool checkcast, bool satb, bool matrix, ShenandoahBarrierSet::ArrayCopyStoreValMode storeval_mode);
127
128 template <typename T, bool CHECKCAST>
129 bool arraycopy_loop_2(T* src, T* dst, size_t length, Klass* bound,
130 bool satb, bool matrix, ShenandoahBarrierSet::ArrayCopyStoreValMode storeval_mode);
131
132 template <typename T, bool CHECKCAST, bool SATB>
133 bool arraycopy_loop_3(T* src, T* dst, size_t length, Klass* bound,
134 bool matrix, ShenandoahBarrierSet::ArrayCopyStoreValMode storeval_mode);
135
136 template <typename T, bool CHECKCAST, bool SATB, bool MATRIX>
137 bool arraycopy_loop_4(T* src, T* dst, size_t length, Klass* bound,
138 ShenandoahBarrierSet::ArrayCopyStoreValMode storeval_mode);
139
140 template <typename T, bool CHECKCAST, bool SATB, bool MATRIX, ShenandoahBarrierSet::ArrayCopyStoreValMode STOREVAL_MODE>
141 bool arraycopy_loop(T* src, T* dst, size_t length, Klass* bound);
142
143 template <typename T, bool CHECKCAST, bool SATB, bool MATRIX, ShenandoahBarrierSet::ArrayCopyStoreValMode STOREVAL_MODE>
144 bool arraycopy_element(T* cur_src, T* cur_dst, Klass* bound, Thread* thread);
145
146 public:
147 // Callbacks for runtime accesses.
148 template <DecoratorSet decorators, typename BarrierSetT = ShenandoahBarrierSet>
149 class AccessBarrier: public BarrierSet::AccessBarrier<decorators, BarrierSetT> {
150 typedef BarrierSet::AccessBarrier<decorators, BarrierSetT> Raw;
151
152 public:
153 // Primitive heap accesses. These accessors get resolved when
154 // IN_HEAP is set (e.g. when using the HeapAccess API), it is
155 // not an oop_* overload, and the barrier strength is AS_NORMAL.
156 template <typename T>
157 static T load_in_heap(T* addr) {
158 ShouldNotReachHere();
159 return Raw::template load<T>(addr);
160 }
161
162 template <typename T>
163 static T load_in_heap_at(oop base, ptrdiff_t offset) {
164 base = ShenandoahBarrierSet::resolve_forwarded(base);
165 return Raw::template load_at<T>(base, offset);
166 }
167
168 template <typename T>
169 static void store_in_heap(T* addr, T value) {
170 ShouldNotReachHere();
171 Raw::store(addr, value);
172 }
173
174 template <typename T>
175 static void store_in_heap_at(oop base, ptrdiff_t offset, T value) {
176 base = ShenandoahBarrierSet::barrier_set()->write_barrier(base);
177 Raw::store_at(base, offset, value);
178 }
179
180 template <typename T>
181 static T atomic_cmpxchg_in_heap(T new_value, T* addr, T compare_value) {
182 ShouldNotReachHere();
183 return Raw::atomic_cmpxchg(new_value, addr, compare_value);
184 }
185
186 template <typename T>
187 static T atomic_cmpxchg_in_heap_at(T new_value, oop base, ptrdiff_t offset, T compare_value) {
188 base = ShenandoahBarrierSet::barrier_set()->write_barrier(base);
189 return Raw::atomic_cmpxchg_at(new_value, base, offset, compare_value);
190 }
191
192 template <typename T>
193 static T atomic_xchg_in_heap(T new_value, T* addr) {
194 ShouldNotReachHere();
195 return Raw::atomic_xchg(new_value, addr);
196 }
197
198 template <typename T>
199 static T atomic_xchg_in_heap_at(T new_value, oop base, ptrdiff_t offset) {
200 base = ShenandoahBarrierSet::barrier_set()->write_barrier(base);
201 return Raw::atomic_xchg_at(new_value, base, offset);
202 }
203
204 template <typename T>
205 static void arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, T* src_raw,
206 arrayOop dst_obj, size_t dst_offset_in_bytes, T* dst_raw,
207 size_t length);
208
209 // Heap oop accesses. These accessors get resolved when
210 // IN_HEAP is set (e.g. when using the HeapAccess API), it is
211 // an oop_* overload, and the barrier strength is AS_NORMAL.
212 template <typename T>
213 static oop oop_load_in_heap(T* addr) {
214 // ShouldNotReachHere();
215 oop value = Raw::template oop_load<oop>(addr);
216 keep_alive_if_weak(decorators, value);
217 return value;
218 }
219
220 static oop oop_load_in_heap_at(oop base, ptrdiff_t offset) {
221 base = ShenandoahBarrierSet::resolve_forwarded(base);
222 oop value = Raw::template oop_load_at<oop>(base, offset);
223 keep_alive_if_weak(AccessBarrierSupport::resolve_possibly_unknown_oop_ref_strength<decorators>(base, offset), value);
224 return value;
225 }
226
227 template <typename T>
228 static void oop_store_in_heap(T* addr, oop value) {
229 ShenandoahBarrierSet::barrier_set()->write_ref_field_pre_work(addr, value);
230 Raw::oop_store(addr, value);
231 }
232
233 static void oop_store_in_heap_at(oop base, ptrdiff_t offset, oop value) {
234 base = ShenandoahBarrierSet::barrier_set()->write_barrier(base);
235 value = ShenandoahBarrierSet::barrier_set()->storeval_barrier(value);
236
237 oop_store_in_heap(AccessInternal::oop_field_addr<decorators>(base, offset), value);
238 }
239
240 template <typename T>
241 static oop oop_atomic_cmpxchg_in_heap(oop new_value, T* addr, oop compare_value);
242
243 static oop oop_atomic_cmpxchg_in_heap_at(oop new_value, oop base, ptrdiff_t offset, oop compare_value) {
244 base = ShenandoahBarrierSet::barrier_set()->write_barrier(base);
245 new_value = ShenandoahBarrierSet::barrier_set()->storeval_barrier(new_value);
246 return oop_atomic_cmpxchg_in_heap(new_value, AccessInternal::oop_field_addr<decorators>(base, offset), compare_value);
247 }
248
249 template <typename T>
250 static oop oop_atomic_xchg_in_heap(oop new_value, T* addr);
251
252 static oop oop_atomic_xchg_in_heap_at(oop new_value, oop base, ptrdiff_t offset) {
253 base = ShenandoahBarrierSet::barrier_set()->write_barrier(base);
254 new_value = ShenandoahBarrierSet::barrier_set()->storeval_barrier(new_value);
255 return oop_atomic_xchg_in_heap(new_value, AccessInternal::oop_field_addr<decorators>(base, offset));
256 }
257
258 template <typename T>
259 static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, T* src_raw,
260 arrayOop dst_obj, size_t dst_offset_in_bytes, T* dst_raw,
261 size_t length);
262
263 // Clone barrier support
264 static void clone_in_heap(oop src, oop dst, size_t size);
265
266 // Needed for loads on non-heap weak references
267 template <typename T>
268 static oop oop_load_not_in_heap(T* addr) {
269 oop value = Raw::oop_load_not_in_heap(addr);
270 keep_alive_if_weak(decorators, value);
271 return value;
272 }
273
274 static oop resolve(oop obj) {
275 return ShenandoahBarrierSet::barrier_set()->write_barrier(obj);
276 }
277
278 static bool equals(oop o1, oop o2) {
279 return ShenandoahBarrierSet::barrier_set()->obj_equals(o1, o2);
280 }
281
282 };
283
284 };
285
286 template<>
287 struct BarrierSet::GetName<ShenandoahBarrierSet> {
288 static const BarrierSet::Name value = BarrierSet::Shenandoah;
289 };
290
291 template<>
292 struct BarrierSet::GetType<BarrierSet::Shenandoah> {
293 typedef ShenandoahBarrierSet type;
294 };
295
296 #endif //SHARE_VM_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP