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 template <DecoratorSet decorators, typename BarrierSetT = ZBarrierSet>
69 class AccessBarrier : public BarrierSet::AccessBarrier<decorators, BarrierSetT> {
70 private:
71 typedef BarrierSet::AccessBarrier<decorators, BarrierSetT> Raw;
72
73 template <DecoratorSet expected>
74 static void verify_decorators_present();
75
76 template <DecoratorSet expected>
77 static void verify_decorators_absent();
78
79 static zpointer* field_addr(oop base, ptrdiff_t offset);
80
81 static zaddress load_barrier(zpointer* p, zpointer o);
82 static zaddress load_barrier_on_unknown_oop_ref(oop base, ptrdiff_t offset, zpointer* p, zpointer o);
83
84 static void store_barrier_heap_with_healing(zpointer* p);
85 static void store_barrier_heap_without_healing(zpointer* p);
86 static void no_keep_alive_store_barrier_heap(zpointer* p);
87
88 static void store_barrier_native_with_healing(zpointer* p);
89 static void store_barrier_native_without_healing(zpointer* p);
90
91 static void unsupported();
92 static zaddress load_barrier(narrowOop* p, zpointer o) { unsupported(); return zaddress::null; }
93 static zaddress load_barrier_on_unknown_oop_ref(oop base, ptrdiff_t offset, narrowOop* p, zpointer o) { unsupported(); return zaddress::null; }
94 static void store_barrier_heap_with_healing(narrowOop* p) { unsupported(); }
95 static void store_barrier_heap_without_healing(narrowOop* p) { unsupported(); }
96 static void no_keep_alive_store_barrier_heap(narrowOop* p) { unsupported(); }
97 static void store_barrier_native_with_healing(narrowOop* p) { unsupported(); }
98 static void store_barrier_native_without_healing(narrowOop* p) { unsupported(); }
99
100 static zaddress oop_copy_one_barriers(zpointer* dst, zpointer* src);
101 static bool oop_copy_one_check_cast(zpointer* dst, zpointer* src, Klass* dst_klass);
102 static void oop_copy_one(zpointer* dst, zpointer* src);
103
104 static bool oop_arraycopy_in_heap_check_cast(zpointer* dst, zpointer* src, size_t length, Klass* dst_klass);
105 static bool oop_arraycopy_in_heap_no_check_cast(zpointer* dst, zpointer* src, size_t length);
106
107 public:
108 //
109 // In heap
110 //
111 static oop oop_load_in_heap(zpointer* p);
112 static oop oop_load_in_heap(oop* p) { return oop_load_in_heap((zpointer*)p); };
113 static oop oop_load_in_heap(narrowOop* p) { unsupported(); return nullptr; }
114
115 static oop oop_load_in_heap_at(oop base, ptrdiff_t offset);
116
117 static void oop_store_in_heap(zpointer* p, oop value);
118 static void oop_store_in_heap(oop* p, oop value) { oop_store_in_heap((zpointer*)p, value); }
119 static void oop_store_in_heap(narrowOop* p, oop value) { unsupported(); }
120 static void oop_store_in_heap_at(oop base, ptrdiff_t offset, oop value);
121
122 static void oop_store_not_in_heap(zpointer* p, oop value);
123 static void oop_store_not_in_heap(oop* p, oop value) { oop_store_not_in_heap((zpointer*)p, value); }
124 static void oop_store_not_in_heap(narrowOop* p, oop value) { unsupported(); }
125 static void oop_store_not_in_heap_at(oop base, ptrdiff_t offset, oop value);
126
127 static oop oop_atomic_cmpxchg_in_heap(zpointer* p, oop compare_value, oop new_value);
128 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); }
129 static oop oop_atomic_cmpxchg_in_heap(narrowOop* p, oop compare_value, oop new_value) { unsupported(); return nullptr; }
130 static oop oop_atomic_cmpxchg_in_heap_at(oop base, ptrdiff_t offset, oop compare_value, oop new_value);
131
132 static oop oop_atomic_xchg_in_heap(zpointer* p, oop new_value);
133 static oop oop_atomic_xchg_in_heap(oop* p, oop new_value) { return oop_atomic_xchg_in_heap((zpointer*)p, new_value); }
134 static oop oop_atomic_xchg_in_heap(narrowOop* p, oop new_value) { unsupported(); return nullptr; }
135 static oop oop_atomic_xchg_in_heap_at(oop base, ptrdiff_t offset, oop new_value);
136
137 static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, zpointer* src_raw,
138 arrayOop dst_obj, size_t dst_offset_in_bytes, zpointer* dst_raw,
139 size_t length);
140 static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, oop* src_raw,
141 arrayOop dst_obj, size_t dst_offset_in_bytes, oop* dst_raw,
142 size_t length) {
143 return oop_arraycopy_in_heap(src_obj, src_offset_in_bytes, (zpointer*)src_raw,
144 dst_obj, dst_offset_in_bytes, (zpointer*)dst_raw,
145 length);
146 }
147 static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, narrowOop* src_raw,
148 arrayOop dst_obj, size_t dst_offset_in_bytes, narrowOop* dst_raw,
149 size_t length) { unsupported(); return false; }
150
151 static void clone_in_heap(oop src, oop dst, size_t size);
152
153 //
154 // Not in heap
155 //
156 static oop oop_load_not_in_heap(zpointer* p);
157 static oop oop_load_not_in_heap(oop* p);
158 static oop oop_load_not_in_heap(narrowOop* p) { unsupported(); return nullptr; }
159
160 static oop oop_atomic_cmpxchg_not_in_heap(zpointer* p, oop compare_value, oop new_value);
161 static oop oop_atomic_cmpxchg_not_in_heap(oop* p, oop compare_value, oop new_value) {
162 return oop_atomic_cmpxchg_not_in_heap((zpointer*)p, compare_value, new_value);
163 }
164 static oop oop_atomic_cmpxchg_not_in_heap(narrowOop* addr, oop compare_value, oop new_value) { unsupported(); return nullptr; }
165
166 static oop oop_atomic_xchg_not_in_heap(zpointer* p, oop new_value);
167 static oop oop_atomic_xchg_not_in_heap(oop* p, oop new_value) { return oop_atomic_xchg_not_in_heap((zpointer*)p, new_value); }
168 static oop oop_atomic_xchg_not_in_heap(narrowOop* p, oop new_value) { unsupported(); return nullptr; }
169 };
170 };
171
172 template<> struct BarrierSet::GetName<ZBarrierSet> {
173 static const BarrierSet::Name Value = BarrierSet::ZBarrierSet;
174 };
175
176 template<> struct BarrierSet::GetType<BarrierSet::ZBarrierSet> {
177 typedef ::ZBarrierSet type;
178 };
179
180 #endif // SHARE_GC_Z_ZBARRIERSET_HPP