1 /*
2 * Copyright (c) 2015, 2025, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23
24 #ifndef SHARE_GC_Z_ZBARRIERSET_HPP
25 #define SHARE_GC_Z_ZBARRIERSET_HPP
26
27 #include "gc/shared/barrierSet.hpp"
28 #include "gc/z/zAddress.hpp"
29
30 class ZBarrierSetAssembler;
31 class ValuePayload;
32
33 class ZBarrierSet : public BarrierSet {
34 private:
35 static zpointer store_good(oop obj);
36
37 static void load_barrier_all(oop src, size_t size);
38 static void color_store_good_all(oop dst, size_t size);
39
40 static zaddress load_barrier_on_oop_field_preloaded(volatile zpointer* p, zpointer o);
41 static zaddress no_keep_alive_load_barrier_on_weak_oop_field_preloaded(volatile zpointer* p, zpointer o);
42 static zaddress no_keep_alive_load_barrier_on_phantom_oop_field_preloaded(volatile zpointer* p, zpointer o);
43 static zaddress load_barrier_on_weak_oop_field_preloaded(volatile zpointer* p, zpointer o);
44 static zaddress load_barrier_on_phantom_oop_field_preloaded(volatile zpointer* p, zpointer o);
45
46 static void store_barrier_on_heap_oop_field(volatile zpointer* p, bool heal);
47 static void no_keep_alive_store_barrier_on_heap_oop_field(volatile zpointer* p);
48 static void store_barrier_on_native_oop_field(volatile zpointer* p, bool heal);
49
50 static zaddress load_barrier_on_oop_field(volatile zpointer* p);
51
52 class ZClonerOopClosure;
53 static void clone_obj(zaddress src, zaddress dst, size_t size);
54
55 public:
56 ZBarrierSet();
57
58 static ZBarrierSetAssembler* assembler();
59 static bool barrier_needed(DecoratorSet decorators, BasicType type);
60
61 virtual void on_thread_create(Thread* thread);
62 virtual void on_thread_destroy(Thread* thread);
63 virtual void on_thread_attach(Thread* thread);
64 virtual void on_thread_detach(Thread* thread);
65
66 virtual void on_slowpath_allocation_exit(JavaThread* thread, oop new_obj);
67
68 virtual void print_on(outputStream* st) const;
69
70 template <DecoratorSet decorators, typename BarrierSetT = ZBarrierSet>
71 class AccessBarrier : public BarrierSet::AccessBarrier<decorators, BarrierSetT> {
72 private:
73 typedef BarrierSet::AccessBarrier<decorators, BarrierSetT> Raw;
74
75 template <DecoratorSet expected>
76 static void verify_decorators_present();
77
78 template <DecoratorSet expected>
79 static void verify_decorators_absent();
80
81 static zpointer* field_addr(oop base, ptrdiff_t offset);
82
83 static zaddress load_barrier(zpointer* p, zpointer o);
84 static zaddress load_barrier_on_unknown_oop_ref(oop base, ptrdiff_t offset, zpointer* p, zpointer o);
85
86 static void store_barrier_heap_with_healing(zpointer* p);
87 static void store_barrier_heap_without_healing(zpointer* p);
88 static void no_keep_alive_store_barrier_heap(zpointer* p);
89
90 static void store_barrier_native_with_healing(zpointer* p);
91 static void store_barrier_native_without_healing(zpointer* p);
92
93 [[noreturn]]
94 static void unsupported();
95 static zaddress load_barrier(narrowOop* p, zpointer o) { unsupported(); return zaddress::null; }
96 static zaddress load_barrier_on_unknown_oop_ref(oop base, ptrdiff_t offset, narrowOop* p, zpointer o) { unsupported(); return zaddress::null; }
97 static void store_barrier_heap_with_healing(narrowOop* p) { unsupported(); }
98 static void store_barrier_heap_without_healing(narrowOop* p) { unsupported(); }
99 static void no_keep_alive_store_barrier_heap(narrowOop* p) { unsupported(); }
100 static void store_barrier_native_with_healing(narrowOop* p) { unsupported(); }
101 static void store_barrier_native_without_healing(narrowOop* p) { unsupported(); }
102
103 static zaddress oop_copy_one_barriers(zpointer* dst, zpointer* src);
104 static OopCopyResult oop_copy_one_check_cast(zpointer* dst, zpointer* src, Klass* dst_klass);
105 static OopCopyResult oop_copy_one(zpointer* dst, zpointer* src);
106 static OopCopyResult oop_clear_one(zpointer* dst);
107
108 static OopCopyResult oop_arraycopy_in_heap_check_cast(zpointer* dst, zpointer* src, size_t length, Klass* dst_klass);
109 static OopCopyResult oop_arraycopy_in_heap_no_check_cast(zpointer* dst, zpointer* src, size_t length);
110
111 public:
112 //
113 // In heap
114 //
115 static oop oop_load_in_heap(zpointer* p);
116 static oop oop_load_in_heap(oop* p) { return oop_load_in_heap((zpointer*)p); };
117 static oop oop_load_in_heap(narrowOop* p) { unsupported(); return nullptr; }
118
119 static oop oop_load_in_heap_at(oop base, ptrdiff_t offset);
120
121 static void oop_store_in_heap(zpointer* p, oop value);
122 static void oop_store_in_heap(oop* p, oop value) { oop_store_in_heap((zpointer*)p, value); }
123 static void oop_store_in_heap(narrowOop* p, oop value) { unsupported(); }
124 static void oop_store_in_heap_at(oop base, ptrdiff_t offset, oop value);
125
126 static void oop_store_not_in_heap(zpointer* p, oop value);
127 static void oop_store_not_in_heap(oop* p, oop value) { oop_store_not_in_heap((zpointer*)p, value); }
128 static void oop_store_not_in_heap(narrowOop* p, oop value) { unsupported(); }
129 static void oop_store_not_in_heap_at(oop base, ptrdiff_t offset, oop value);
130
131 static oop oop_atomic_cmpxchg_in_heap(zpointer* p, oop compare_value, oop new_value);
132 static oop oop_atomic_cmpxchg_in_heap(oop* p, oop compare_value, oop new_value) { return oop_atomic_cmpxchg_in_heap((zpointer*)p, compare_value, new_value); }
133 static oop oop_atomic_cmpxchg_in_heap(narrowOop* p, oop compare_value, oop new_value) { unsupported(); return nullptr; }
134 static oop oop_atomic_cmpxchg_in_heap_at(oop base, ptrdiff_t offset, oop compare_value, oop new_value);
135
136 static oop oop_atomic_xchg_in_heap(zpointer* p, oop new_value);
137 static oop oop_atomic_xchg_in_heap(oop* p, oop new_value) { return oop_atomic_xchg_in_heap((zpointer*)p, new_value); }
138 static oop oop_atomic_xchg_in_heap(narrowOop* p, oop new_value) { unsupported(); return nullptr; }
139 static oop oop_atomic_xchg_in_heap_at(oop base, ptrdiff_t offset, oop new_value);
140
141 static OopCopyResult oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, zpointer* src_raw,
142 arrayOop dst_obj, size_t dst_offset_in_bytes, zpointer* dst_raw,
143 size_t length);
144 static OopCopyResult oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, oop* src_raw,
145 arrayOop dst_obj, size_t dst_offset_in_bytes, oop* dst_raw,
146 size_t length) {
147 return oop_arraycopy_in_heap(src_obj, src_offset_in_bytes, (zpointer*)src_raw,
148 dst_obj, dst_offset_in_bytes, (zpointer*)dst_raw,
149 length);
150 }
151 static OopCopyResult oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, narrowOop* src_raw,
152 arrayOop dst_obj, size_t dst_offset_in_bytes, narrowOop* dst_raw,
153 size_t length) { unsupported(); }
154
155 static void clone_in_heap(oop src, oop dst, size_t size);
156
157 static void value_copy_in_heap(const ValuePayload& src, const ValuePayload& dst);
158 static void value_store_null_in_heap(const ValuePayload& dst);
159
160 //
161 // Not in heap
162 //
163 static oop oop_load_not_in_heap(zpointer* p);
164 static oop oop_load_not_in_heap(oop* p);
165 static oop oop_load_not_in_heap(narrowOop* p) { unsupported(); return nullptr; }
166
167 static oop oop_atomic_cmpxchg_not_in_heap(zpointer* p, oop compare_value, oop new_value);
168 static oop oop_atomic_cmpxchg_not_in_heap(oop* p, oop compare_value, oop new_value) {
169 return oop_atomic_cmpxchg_not_in_heap((zpointer*)p, compare_value, new_value);
170 }
171 static oop oop_atomic_cmpxchg_not_in_heap(narrowOop* addr, oop compare_value, oop new_value) { unsupported(); return nullptr; }
172
173 static oop oop_atomic_xchg_not_in_heap(zpointer* p, oop new_value);
174 static oop oop_atomic_xchg_not_in_heap(oop* p, oop new_value) { return oop_atomic_xchg_not_in_heap((zpointer*)p, new_value); }
175 static oop oop_atomic_xchg_not_in_heap(narrowOop* p, oop new_value) { unsupported(); return nullptr; }
176 };
177 };
178
179 template<> struct BarrierSet::GetName<ZBarrierSet> {
180 static const BarrierSet::Name Value = BarrierSet::ZBarrierSet;
181 };
182
183 template<> struct BarrierSet::GetType<BarrierSet::ZBarrierSet> {
184 typedef ::ZBarrierSet type;
185 };
186
187 #endif // SHARE_GC_Z_ZBARRIERSET_HPP