1 /*
2 * Copyright (c) 2013, 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_SHENANDOAHBARRIERSET_HPP
25 #define SHARE_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 ShenandoahBarrierSetAssembler;
33
34 class ShenandoahBarrierSet: public BarrierSet {
35 private:
36 enum ArrayCopyStoreValMode {
37 NONE,
38 READ_BARRIER,
39 WRITE_BARRIER
40 };
41
42 ShenandoahHeap* _heap;
43 ShenandoahSATBMarkQueueSet _satb_mark_queue_set;
44
45 public:
46 ShenandoahBarrierSet(ShenandoahHeap* heap);
47
48 static ShenandoahBarrierSetAssembler* assembler();
49
50 inline static ShenandoahBarrierSet* barrier_set() {
51 return barrier_set_cast<ShenandoahBarrierSet>(BarrierSet::barrier_set());
52 }
53
54 static ShenandoahSATBMarkQueueSet& satb_mark_queue_set() {
55 return barrier_set()->_satb_mark_queue_set;
56 }
57
58 void print_on(outputStream* st) const;
59
60 bool is_a(BarrierSet::Name bsn);
61
62 bool is_aligned(HeapWord* hw);
63
64 void write_ref_array(HeapWord* start, size_t count);
65
66 template <class T> void
67 write_ref_array_pre_work(T* dst, size_t count);
68
69 void write_ref_array_pre(oop* dst, size_t count, bool dest_uninitialized);
70
71 void write_ref_array_pre(narrowOop* dst, size_t count, bool dest_uninitialized);
72
73 // We export this to make it available in cases where the static
74 // type of the barrier set is known. Note that it is non-virtual.
75 template <class T> inline void inline_write_ref_field_pre(T* field, oop new_val);
76
77 // These are the more general virtual versions.
78 void write_ref_field_pre_work(oop* field, oop new_val);
79 void write_ref_field_pre_work(narrowOop* field, oop new_val);
80 void write_ref_field_pre_work(void* field, oop new_val);
81
82 void write_ref_field_work(void* v, oop o, bool release = false);
83 void write_region(MemRegion mr);
84
85 virtual void on_thread_create(Thread* thread);
86 virtual void on_thread_destroy(Thread* thread);
87 virtual void on_thread_attach(Thread* thread);
88 virtual void on_thread_detach(Thread* thread);
89 virtual bool needs_sts_sync_on_attach_detach() { return true; }
90
91 static inline oop resolve_forwarded_not_null(oop p);
92 static inline oop resolve_forwarded(oop p);
93
94 void storeval_barrier(oop obj);
95 void keep_alive_barrier(oop obj);
96
97 oop load_reference_barrier(oop obj);
98 oop load_reference_barrier_mutator(oop obj);
99 oop load_reference_barrier_not_null(oop obj);
100
101 void enqueue(oop obj);
102
103 private:
104 inline bool need_update_refs_barrier();
105
106 template <class T, bool STOREVAL_WRITE_BARRIER>
107 void write_ref_array_loop(HeapWord* start, size_t count);
108
109 oop load_reference_barrier_impl(oop obj);
110
111 static void keep_alive_if_weak(DecoratorSet decorators, oop value) {
112 assert((decorators & ON_UNKNOWN_OOP_REF) == 0, "Reference strength must be known");
113 const bool on_strong_oop_ref = (decorators & ON_STRONG_OOP_REF) != 0;
114 const bool peek = (decorators & AS_NO_KEEPALIVE) != 0;
115 if (!peek && !on_strong_oop_ref && value != NULL) {
116 ShenandoahBarrierSet::barrier_set()->keep_alive_barrier(value);
117 }
118 }
119
120 template <typename T>
121 bool arraycopy_loop_1(T* src, T* dst, size_t length, Klass* bound,
122 bool checkcast, bool satb, bool disjoint, ShenandoahBarrierSet::ArrayCopyStoreValMode storeval_mode);
123
124 template <typename T, bool CHECKCAST>
125 bool arraycopy_loop_2(T* src, T* dst, size_t length, Klass* bound,
126 bool satb, bool disjoint, ShenandoahBarrierSet::ArrayCopyStoreValMode storeval_mode);
127
128 template <typename T, bool CHECKCAST, bool SATB>
129 bool arraycopy_loop_3(T* src, T* dst, size_t length, Klass* bound,
130 bool disjoint, ShenandoahBarrierSet::ArrayCopyStoreValMode storeval_mode);
131
132 template <typename T, bool CHECKCAST, bool SATB, ShenandoahBarrierSet::ArrayCopyStoreValMode STOREVAL_MODE>
133 bool arraycopy_loop(T* src, T* dst, size_t length, Klass* bound, bool disjoint);
134
135 template <typename T, bool CHECKCAST, bool SATB, ShenandoahBarrierSet::ArrayCopyStoreValMode STOREVAL_MODE>
136 bool arraycopy_element(T* cur_src, T* cur_dst, Klass* bound, Thread* thread);
137
138 public:
139 // Callbacks for runtime accesses.
140 template <DecoratorSet decorators, typename BarrierSetT = ShenandoahBarrierSet>
141 class AccessBarrier: public BarrierSet::AccessBarrier<decorators, BarrierSetT> {
142 typedef BarrierSet::AccessBarrier<decorators, BarrierSetT> Raw;
143
144 template <typename T>
145 static oop oop_atomic_cmpxchg_in_heap_impl(oop new_value, T* addr, oop compare_value);
146
147 template <typename T>
148 static oop oop_atomic_xchg_in_heap_impl(oop new_value, T* addr);
149
150 public:
151 // Heap oop accesses. These accessors get resolved when
152 // IN_HEAP is set (e.g. when using the HeapAccess API), it is
153 // an oop_* overload, and the barrier strength is AS_NORMAL.
154 template <typename T>
155 static oop oop_load_in_heap(T* addr);
156 static oop oop_load_in_heap_at(oop base, ptrdiff_t offset);
157
158 template <typename T>
159 static void oop_store_in_heap(T* addr, oop value);
160 static void oop_store_in_heap_at(oop base, ptrdiff_t offset, oop value);
161
162 template <typename T>
163 static oop oop_atomic_cmpxchg_in_heap(oop new_value, T* addr, oop compare_value);
164 static oop oop_atomic_cmpxchg_in_heap_at(oop new_value, oop base, ptrdiff_t offset, oop compare_value);
165
166 template <typename T>
167 static oop oop_atomic_xchg_in_heap(oop new_value, T* addr);
168 static oop oop_atomic_xchg_in_heap_at(oop new_value, oop base, ptrdiff_t offset);
169
170 template <typename T>
171 static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, T* src_raw,
172 arrayOop dst_obj, size_t dst_offset_in_bytes, T* dst_raw,
173 size_t length);
174
175 // Clone barrier support
176 static void clone_in_heap(oop src, oop dst, size_t size);
177
178 // Needed for loads on non-heap weak references
179 template <typename T>
180 static oop oop_load_not_in_heap(T* addr);
181
182 template <typename T>
183 static oop oop_atomic_cmpxchg_not_in_heap(oop new_value, T* addr, oop compare_value);
184
185 template <typename T>
186 static oop oop_atomic_xchg_not_in_heap(oop new_value, T* addr);
187
188 };
189
190 };
191
192 template<>
193 struct BarrierSet::GetName<ShenandoahBarrierSet> {
194 static const BarrierSet::Name value = BarrierSet::ShenandoahBarrierSet;
195 };
196
197 template<>
198 struct BarrierSet::GetType<BarrierSet::ShenandoahBarrierSet> {
199 typedef ::ShenandoahBarrierSet type;
200 };
201
202 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP