1 /*
2 * Copyright (c) 2015, 2024, 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
32 class ZBarrierSet : public BarrierSet {
33 private:
34 static zpointer store_good(oop obj);
35
36 static void load_barrier_all(oop src, size_t size);
37 static void color_store_good_all(oop dst, size_t size);
38
39 static zaddress load_barrier_on_oop_field_preloaded(volatile zpointer* p, zpointer o);
40 static zaddress no_keep_alive_load_barrier_on_weak_oop_field_preloaded(volatile zpointer* p, zpointer o);
41 static zaddress no_keep_alive_load_barrier_on_phantom_oop_field_preloaded(volatile zpointer* p, zpointer o);
42 static zaddress load_barrier_on_weak_oop_field_preloaded(volatile zpointer* p, zpointer o);
43 static zaddress load_barrier_on_phantom_oop_field_preloaded(volatile zpointer* p, zpointer o);
44
45 static void store_barrier_on_heap_oop_field(volatile zpointer* p, bool heal);
46 static void no_keep_alive_store_barrier_on_heap_oop_field(volatile zpointer* p);
47 static void store_barrier_on_native_oop_field(volatile zpointer* p, bool heal);
48
49 static zaddress load_barrier_on_oop_field(volatile zpointer* p);
50
51 static void clone_obj_array(objArrayOop src, objArrayOop dst);
52
53 public:
54 ZBarrierSet();
55
56 static ZBarrierSetAssembler* assembler();
57 static bool barrier_needed(DecoratorSet decorators, BasicType type);
58
59 virtual void on_thread_create(Thread* thread);
60 virtual void on_thread_destroy(Thread* thread);
61 virtual void on_thread_attach(Thread* thread);
62 virtual void on_thread_detach(Thread* thread);
63
64 virtual void on_slowpath_allocation_exit(JavaThread* thread, oop new_obj);
65
66 virtual void print_on(outputStream* st) const;
67
68 enum OopCopyCheckStatus {
69 oop_copy_check_ok = 0, // oop array copy sucessful
70 oop_copy_check_class_cast = 1, // oop array copy failed subtype check (ARRAYCOPY_CHECKCAST)
71 oop_copy_check_null = 2 // oop array copy failed null check (ARRAYCOPY_NOTNULL)
72 };
73
74 template <DecoratorSet decorators, typename BarrierSetT = ZBarrierSet>
75 class AccessBarrier : public BarrierSet::AccessBarrier<decorators, BarrierSetT> {
76 private:
77 typedef BarrierSet::AccessBarrier<decorators, BarrierSetT> Raw;
78
79 template <DecoratorSet expected>
80 static void verify_decorators_present();
81
82 template <DecoratorSet expected>
83 static void verify_decorators_absent();
84
85 static zpointer* field_addr(oop base, ptrdiff_t offset);
86
87 static zaddress load_barrier(zpointer* p, zpointer o);
88 static zaddress load_barrier_on_unknown_oop_ref(oop base, ptrdiff_t offset, zpointer* p, zpointer o);
89
90 static void store_barrier_heap_with_healing(zpointer* p);
91 static void store_barrier_heap_without_healing(zpointer* p);
92 static void no_keep_alive_store_barrier_heap(zpointer* p);
93
94 static void store_barrier_native_with_healing(zpointer* p);
95 static void store_barrier_native_without_healing(zpointer* p);
96
97 static void unsupported();
98 static zaddress load_barrier(narrowOop* p, zpointer o) { unsupported(); return zaddress::null; }
99 static zaddress load_barrier_on_unknown_oop_ref(oop base, ptrdiff_t offset, narrowOop* p, zpointer o) { unsupported(); return zaddress::null; }
100 static void store_barrier_heap_with_healing(narrowOop* p) { unsupported(); }
101 static void store_barrier_heap_without_healing(narrowOop* p) { unsupported(); }
102 static void no_keep_alive_store_barrier_heap(narrowOop* p) { unsupported(); }
103 static void store_barrier_native_with_healing(narrowOop* p) { unsupported(); }
104 static void store_barrier_native_without_healing(narrowOop* p) { unsupported(); }
105
106 static zaddress oop_copy_one_barriers(zpointer* dst, zpointer* src);
107 static OopCopyCheckStatus oop_copy_one_check_cast(zpointer* dst, zpointer* src, Klass* dst_klass);
108 static OopCopyCheckStatus oop_copy_one(zpointer* dst, zpointer* src);
109
110 static OopCopyCheckStatus oop_arraycopy_in_heap_check_cast(zpointer* dst, zpointer* src, size_t length, Klass* dst_klass);
111 static OopCopyCheckStatus oop_arraycopy_in_heap_no_check_cast(zpointer* dst, zpointer* src, size_t length);
112
113 public:
114 //
115 // In heap
116 //
117 static oop oop_load_in_heap(zpointer* p);
118 static oop oop_load_in_heap(oop* p) { return oop_load_in_heap((zpointer*)p); };
119 static oop oop_load_in_heap(narrowOop* p) { unsupported(); return nullptr; }
120
121 static oop oop_load_in_heap_at(oop base, ptrdiff_t offset);
122
123 static void oop_store_in_heap(zpointer* p, oop value);
124 static void oop_store_in_heap(oop* p, oop value) { oop_store_in_heap((zpointer*)p, value); }
125 static void oop_store_in_heap(narrowOop* p, oop value) { unsupported(); }
126 static void oop_store_in_heap_at(oop base, ptrdiff_t offset, oop value);
127
128 static void oop_store_not_in_heap(zpointer* p, oop value);
129 static void oop_store_not_in_heap(oop* p, oop value) { oop_store_not_in_heap((zpointer*)p, value); }
130 static void oop_store_not_in_heap(narrowOop* p, oop value) { unsupported(); }
131 static void oop_store_not_in_heap_at(oop base, ptrdiff_t offset, oop value);
132
133 static oop oop_atomic_cmpxchg_in_heap(zpointer* p, oop compare_value, oop new_value);
134 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); }
135 static oop oop_atomic_cmpxchg_in_heap(narrowOop* p, oop compare_value, oop new_value) { unsupported(); return nullptr; }
136 static oop oop_atomic_cmpxchg_in_heap_at(oop base, ptrdiff_t offset, oop compare_value, oop new_value);
137
138 static oop oop_atomic_xchg_in_heap(zpointer* p, oop new_value);
139 static oop oop_atomic_xchg_in_heap(oop* p, oop new_value) { return oop_atomic_xchg_in_heap((zpointer*)p, new_value); }
140 static oop oop_atomic_xchg_in_heap(narrowOop* p, oop new_value) { unsupported(); return nullptr; }
141 static oop oop_atomic_xchg_in_heap_at(oop base, ptrdiff_t offset, oop new_value);
142
143 static void oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, zpointer* src_raw,
144 arrayOop dst_obj, size_t dst_offset_in_bytes, zpointer* dst_raw,
145 size_t length);
146 static void oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, oop* src_raw,
147 arrayOop dst_obj, size_t dst_offset_in_bytes, oop* dst_raw,
148 size_t length) {
149 oop_arraycopy_in_heap(src_obj, src_offset_in_bytes, (zpointer*)src_raw,
150 dst_obj, dst_offset_in_bytes, (zpointer*)dst_raw,
151 length);
152 }
153 static void oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, narrowOop* src_raw,
154 arrayOop dst_obj, size_t dst_offset_in_bytes, narrowOop* dst_raw,
155 size_t length) { unsupported(); }
156
157 static void clone_in_heap(oop src, oop dst, size_t size);
158
159 static void value_copy_in_heap(void* src, void* dst, InlineKlass* md, LayoutKind lk);
160
161 //
162 // Not in heap
163 //
164 static oop oop_load_not_in_heap(zpointer* p);
165 static oop oop_load_not_in_heap(oop* p);
166 static oop oop_load_not_in_heap(narrowOop* p) { unsupported(); return nullptr; }
167
168 static oop oop_atomic_cmpxchg_not_in_heap(zpointer* p, oop compare_value, oop new_value);
169 static oop oop_atomic_cmpxchg_not_in_heap(oop* p, oop compare_value, oop new_value) {
170 return oop_atomic_cmpxchg_not_in_heap((zpointer*)p, compare_value, new_value);
171 }
172 static oop oop_atomic_cmpxchg_not_in_heap(narrowOop* addr, oop compare_value, oop new_value) { unsupported(); return nullptr; }
173
174 static oop oop_atomic_xchg_not_in_heap(zpointer* p, oop new_value);
175 static oop oop_atomic_xchg_not_in_heap(oop* p, oop new_value) { return oop_atomic_xchg_not_in_heap((zpointer*)p, new_value); }
176 static oop oop_atomic_xchg_not_in_heap(narrowOop* p, oop new_value) { unsupported(); return nullptr; }
177 };
178 };
179
180 template<> struct BarrierSet::GetName<ZBarrierSet> {
181 static const BarrierSet::Name Value = BarrierSet::ZBarrierSet;
182 };
183
184 template<> struct BarrierSet::GetType<BarrierSet::ZBarrierSet> {
185 typedef ::ZBarrierSet type;
186 };
187
188 #endif // SHARE_GC_Z_ZBARRIERSET_HPP