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 public:
36 enum ArrayCopyStoreValMode {
37 NONE,
38 RESOLVE_BARRIER,
39 EVAC_BARRIER
40 };
41 private:
42
43 ShenandoahHeap* _heap;
44 BufferNode::Allocator _satb_mark_queue_buffer_allocator;
45 ShenandoahSATBMarkQueueSet _satb_mark_queue_set;
46
47 public:
48 ShenandoahBarrierSet(ShenandoahHeap* heap);
49
50 static ShenandoahBarrierSetAssembler* assembler();
51
52 inline static ShenandoahBarrierSet* barrier_set() {
53 return barrier_set_cast<ShenandoahBarrierSet>(BarrierSet::barrier_set());
54 }
55
56 static ShenandoahSATBMarkQueueSet& satb_mark_queue_set() {
57 return barrier_set()->_satb_mark_queue_set;
58 }
59
60 void print_on(outputStream* st) const;
61
62 bool is_a(BarrierSet::Name bsn);
63
64 bool is_aligned(HeapWord* hw);
65
66 template <class T> void
67 write_ref_array_pre_work(T* src, T* dst, size_t count, bool dest_uninitialized);
68
69 inline void arraycopy_pre(oop* src, oop* dst, size_t count);
70 inline void arraycopy_pre(narrowOop* src, narrowOop* dst, size_t count);
71 inline void arraycopy_update(oop* src, size_t count);
72 inline void arraycopy_update(narrowOop* src, size_t count);
73 inline void clone_barrier(oop src);
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
86 oop oop_load_from_native_barrier(oop obj);
87
88 virtual void on_thread_create(Thread* thread);
89 virtual void on_thread_destroy(Thread* thread);
90 virtual void on_thread_attach(Thread* thread);
91 virtual void on_thread_detach(Thread* thread);
92
93 static inline oop resolve_forwarded_not_null(oop p);
94 static inline oop resolve_forwarded(oop p);
95
96 void storeval_barrier(oop obj);
97 void keep_alive_barrier(oop obj);
98
99 oop load_reference_barrier(oop obj);
100 oop load_reference_barrier_not_null(oop obj);
101
102 oop load_reference_barrier_mutator(oop obj, oop* load_addr);
103 oop load_reference_barrier_mutator(oop obj, narrowOop* load_addr);
104
105 template <class T>
106 oop load_reference_barrier_mutator_work(oop obj, T* load_addr);
107
108 void enqueue(oop obj);
109
110 private:
111 template <class T>
112 inline void arraycopy_pre_work(T* src, T* dst, size_t count);
113 template <class T, bool HAS_FWD, bool EVAC, bool ENQUEUE>
114 inline void arraycopy_work(T* src, size_t count);
115 template <class T>
116 inline void arraycopy_update_impl(T* src, size_t count);
117
118 oop load_reference_barrier_impl(oop obj);
119
120 static void keep_alive_if_weak(DecoratorSet decorators, oop value) {
121 assert((decorators & ON_UNKNOWN_OOP_REF) == 0, "Reference strength must be known");
122 const bool on_strong_oop_ref = (decorators & ON_STRONG_OOP_REF) != 0;
123 const bool peek = (decorators & AS_NO_KEEPALIVE) != 0;
124 if (!peek && !on_strong_oop_ref && value != NULL) {
125 ShenandoahBarrierSet::barrier_set()->keep_alive_barrier(value);
126 }
127 }
128
129 public:
130 // Callbacks for runtime accesses.
131 template <DecoratorSet decorators, typename BarrierSetT = ShenandoahBarrierSet>
132 class AccessBarrier: public BarrierSet::AccessBarrier<decorators, BarrierSetT> {
133 typedef BarrierSet::AccessBarrier<decorators, BarrierSetT> Raw;
134
135 template <typename T>
136 static oop oop_atomic_cmpxchg_in_heap_impl(oop new_value, T* addr, oop compare_value);
137
138 template <typename T>
139 static oop oop_atomic_xchg_in_heap_impl(oop new_value, T* addr);
140
141 public:
142 // Heap oop accesses. These accessors get resolved when
143 // IN_HEAP is set (e.g. when using the HeapAccess API), it is
144 // an oop_* overload, and the barrier strength is AS_NORMAL.
145 template <typename T>
146 static oop oop_load_in_heap(T* addr);
147 static oop oop_load_in_heap_at(oop base, ptrdiff_t offset);
148
149 template <typename T>
150 static void oop_store_in_heap(T* addr, oop value);
151 static void oop_store_in_heap_at(oop base, ptrdiff_t offset, oop value);
152
153 template <typename T>
154 static oop oop_atomic_cmpxchg_in_heap(oop new_value, T* addr, oop compare_value);
155 static oop oop_atomic_cmpxchg_in_heap_at(oop new_value, oop base, ptrdiff_t offset, oop compare_value);
156
157 template <typename T>
158 static oop oop_atomic_xchg_in_heap(oop new_value, T* addr);
159 static oop oop_atomic_xchg_in_heap_at(oop new_value, oop base, ptrdiff_t offset);
160
161 template <typename T>
162 static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, T* src_raw,
163 arrayOop dst_obj, size_t dst_offset_in_bytes, T* dst_raw,
164 size_t length);
165
166 // Clone barrier support
167 static void clone_in_heap(oop src, oop dst, size_t size);
168
169 // Needed for loads on non-heap weak references
170 template <typename T>
171 static oop oop_load_not_in_heap(T* addr);
172
173 // Used for catching bad stores
174 template <typename T>
175 static void oop_store_not_in_heap(T* addr, oop value);
176
177 template <typename T>
178 static oop oop_atomic_cmpxchg_not_in_heap(oop new_value, T* addr, oop compare_value);
179
180 template <typename T>
181 static oop oop_atomic_xchg_not_in_heap(oop new_value, T* addr);
182
183 };
184
185 };
186
187 template<>
188 struct BarrierSet::GetName<ShenandoahBarrierSet> {
189 static const BarrierSet::Name value = BarrierSet::ShenandoahBarrierSet;
190 };
191
192 template<>
193 struct BarrierSet::GetType<BarrierSet::ShenandoahBarrierSet> {
194 typedef ::ShenandoahBarrierSet type;
195 };
196
197 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP