1 /*
2 * Copyright (c) 2013, 2021, Red Hat, Inc. All rights reserved.
3 * Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * This code is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 only, as
8 * published by the Free Software Foundation.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 *
24 */
25
26 #ifndef SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP
27 #define SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP
28
29 #include "gc/shared/barrierSet.hpp"
30 #include "gc/shared/bufferNode.hpp"
31 #include "gc/shenandoah/shenandoahSATBMarkQueueSet.hpp"
32
33 class ShenandoahHeap;
34 class ShenandoahBarrierSetAssembler;
35 class ShenandoahCardTable;
36
37 class ShenandoahBarrierSet: public BarrierSet {
38 private:
39 ShenandoahHeap* const _heap;
40 ShenandoahCardTable* _card_table;
41 BufferNode::Allocator _satb_mark_queue_buffer_allocator;
42 ShenandoahSATBMarkQueueSet _satb_mark_queue_set;
43
44 public:
45 ShenandoahBarrierSet(ShenandoahHeap* heap, MemRegion heap_region);
46
47 static ShenandoahBarrierSetAssembler* assembler();
48
49 inline static ShenandoahBarrierSet* barrier_set() {
50 return barrier_set_cast<ShenandoahBarrierSet>(BarrierSet::barrier_set());
51 }
52
53 inline ShenandoahCardTable* card_table() {
54 return _card_table;
55 }
56
57 static ShenandoahSATBMarkQueueSet& satb_mark_queue_set() {
58 return barrier_set()->_satb_mark_queue_set;
59 }
60
61 static bool need_load_reference_barrier(DecoratorSet decorators, BasicType type);
62 static bool need_keep_alive_barrier(DecoratorSet decorators, BasicType type);
63
64 static bool is_strong_access(DecoratorSet decorators) {
65 return (decorators & (ON_WEAK_OOP_REF | ON_PHANTOM_OOP_REF)) == 0;
66 }
67
68 static bool is_weak_access(DecoratorSet decorators) {
69 return (decorators & ON_WEAK_OOP_REF) != 0;
70 }
71
72 static bool is_phantom_access(DecoratorSet decorators) {
73 return (decorators & ON_PHANTOM_OOP_REF) != 0;
74 }
75
76 static bool is_native_access(DecoratorSet decorators) {
77 return (decorators & IN_NATIVE) != 0;
78 }
79
80 void print_on(outputStream* st) const override;
81
82 template <class T>
83 inline void arraycopy_barrier(T* src, T* dst, size_t count);
84 inline void clone_barrier(oop src);
85 void clone_barrier_runtime(oop src);
86
87 // Support for optimizing compilers to call the barrier set on slow path allocations
88 // that did not enter a TLAB. Used for e.g. ReduceInitialCardMarks to take any
89 // compensating actions to restore card-marks that might otherwise be incorrectly elided.
90 void on_slowpath_allocation_exit(JavaThread* thread, oop new_obj) override;
91 void on_thread_create(Thread* thread) override;
92 void on_thread_destroy(Thread* thread) override;
93 void on_thread_attach(Thread* thread) override;
94 void on_thread_detach(Thread* thread) override;
95
96 static inline oop resolve_forwarded_not_null(oop p);
97 static inline oop resolve_forwarded_not_null_mutator(oop p);
98 static inline oop resolve_forwarded(oop p);
99
100 template <DecoratorSet decorators, typename T>
101 inline void satb_barrier(T* field);
102 inline void satb_enqueue(oop value);
103
104 inline void keep_alive_if_weak(DecoratorSet decorators, oop value);
105
106 inline void enqueue(oop obj);
107
108 inline oop load_reference_barrier(oop obj);
109
110 template <class T>
111 inline oop load_reference_barrier_mutator(oop obj, T* load_addr);
112
113 template <class T>
114 inline oop load_reference_barrier(DecoratorSet decorators, oop obj, T* load_addr);
115
116 template <typename T>
117 inline oop oop_load(DecoratorSet decorators, T* addr);
118
119 template <typename T>
120 inline oop oop_cmpxchg(DecoratorSet decorators, T* addr, oop compare_value, oop new_value);
121
122 template <typename T>
123 inline oop oop_xchg(DecoratorSet decorators, T* addr, oop new_value);
124
125 template <DecoratorSet decorators, typename T>
126 void write_ref_field_post(T* field);
127
128 void write_ref_array(HeapWord* start, size_t count);
129
130 private:
131 template <class T>
132 inline void arraycopy_marking(T* src, T* dst, size_t count, bool is_old_marking);
133 template <class T>
134 inline void arraycopy_evacuation(T* src, size_t count);
135 template <class T>
136 inline void arraycopy_update(T* src, size_t count);
137
138 inline void clone_evacuation(oop src);
139 inline void clone_update(oop src);
140
141 template <class T, bool HAS_FWD, bool EVAC, bool ENQUEUE>
142 inline void arraycopy_work(T* src, size_t count);
143
144 inline bool need_bulk_update(HeapWord* dst);
145 public:
146 // Callbacks for runtime accesses.
147 template <DecoratorSet decorators, typename BarrierSetT = ShenandoahBarrierSet>
148 class AccessBarrier: public BarrierSet::AccessBarrier<decorators, BarrierSetT> {
149 typedef BarrierSet::AccessBarrier<decorators, BarrierSetT> Raw;
150
151 private:
152 template <typename T>
153 static void oop_store_common(T* addr, oop value);
154
155 public:
156 // Heap oop accesses. These accessors get resolved when
157 // IN_HEAP is set (e.g. when using the HeapAccess API), it is
158 // an oop_* overload, and the barrier strength is AS_NORMAL.
159 template <typename T>
160 static oop oop_load_in_heap(T* addr);
161 static oop oop_load_in_heap_at(oop base, ptrdiff_t offset);
162
163 template <typename T>
164 static void oop_store_in_heap(T* addr, oop value);
165 static void oop_store_in_heap_at(oop base, ptrdiff_t offset, oop value);
166
167 template <typename T>
168 static oop oop_atomic_cmpxchg_in_heap(T* addr, oop compare_value, oop new_value);
169 static oop oop_atomic_cmpxchg_in_heap_at(oop base, ptrdiff_t offset, oop compare_value, oop new_value);
170
171 template <typename T>
172 static oop oop_atomic_xchg_in_heap(T* addr, oop new_value);
173 static oop oop_atomic_xchg_in_heap_at(oop base, ptrdiff_t offset, oop new_value);
174
175 template <typename T>
176 static void oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, T* src_raw,
177 arrayOop dst_obj, size_t dst_offset_in_bytes, T* dst_raw,
178 size_t length);
179
180 // Clone barrier support
181 static void clone_in_heap(oop src, oop dst, size_t size);
182
183 // Support for concurrent roots evacuation, updating and weak roots clearing
184 template <typename T>
185 static oop oop_load_not_in_heap(T* addr);
186
187 // Support for concurrent roots marking
188 template <typename T>
189 static void oop_store_not_in_heap(T* addr, oop value);
190
191 template <typename T>
192 static oop oop_atomic_cmpxchg_not_in_heap(T* addr, oop compare_value, oop new_value);
193
194 template <typename T>
195 static oop oop_atomic_xchg_not_in_heap(T* addr, oop new_value);
196 };
197
198 };
199
200 template<>
201 struct BarrierSet::GetName<ShenandoahBarrierSet> {
202 static const BarrierSet::Name value = BarrierSet::ShenandoahBarrierSet;
203 };
204
205 template<>
206 struct BarrierSet::GetType<BarrierSet::ShenandoahBarrierSet> {
207 typedef ::ShenandoahBarrierSet type;
208 };
209
210 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP