1 /*
  2  * Copyright (c) 2015, 2023, 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 public:
 37   ZBarrierSet();
 38 
 39   static ZBarrierSetAssembler* assembler();
 40   static bool barrier_needed(DecoratorSet decorators, BasicType type);
 41 
 42   virtual void on_thread_create(Thread* thread);
 43   virtual void on_thread_destroy(Thread* thread);
 44   virtual void on_thread_attach(Thread* thread);
 45   virtual void on_thread_detach(Thread* thread);
 46 
 47   virtual void on_slowpath_allocation_exit(JavaThread* thread, oop new_obj);
 48 
 49   virtual void print_on(outputStream* st) const;
 50 
 51   template <DecoratorSet decorators, typename BarrierSetT = ZBarrierSet>
 52   class AccessBarrier : public BarrierSet::AccessBarrier<decorators, BarrierSetT> {
 53   private:
 54     typedef BarrierSet::AccessBarrier<decorators, BarrierSetT> Raw;
 55 
 56     template <DecoratorSet expected>
 57     static void verify_decorators_present();
 58 
 59     template <DecoratorSet expected>
 60     static void verify_decorators_absent();
 61 
 62     static zpointer* field_addr(oop base, ptrdiff_t offset);
 63 
 64     static zaddress load_barrier(zpointer* p, zpointer o);
 65     static zaddress load_barrier_on_unknown_oop_ref(oop base, ptrdiff_t offset, zpointer* p, zpointer o);
 66 
 67     static void store_barrier_heap_with_healing(zpointer* p);
 68     static void store_barrier_heap_without_healing(zpointer* p);
 69     static void no_keep_alive_store_barrier_heap(zpointer* p);
 70 
 71     static void store_barrier_native_with_healing(zpointer* p);
 72     static void store_barrier_native_without_healing(zpointer* p);
 73 
 74     static void unsupported();
 75     static zaddress load_barrier(narrowOop* p, zpointer o) { unsupported(); return zaddress::null; }
 76     static zaddress load_barrier_on_unknown_oop_ref(oop base, ptrdiff_t offset, narrowOop* p, zpointer o) { unsupported(); return zaddress::null; }
 77     static void store_barrier_heap_with_healing(narrowOop* p) { unsupported(); }
 78     static void store_barrier_heap_without_healing(narrowOop* p)  { unsupported(); }
 79     static void no_keep_alive_store_barrier_heap(narrowOop* p)  { unsupported(); }
 80     static void store_barrier_native_with_healing(narrowOop* p)  { unsupported(); }
 81     static void store_barrier_native_without_healing(narrowOop* p)  { unsupported(); }
 82 
 83     static zaddress oop_copy_one_barriers(zpointer* dst, zpointer* src);
 84     static bool oop_copy_one_check_cast(zpointer* dst, zpointer* src, Klass* dst_klass);
 85     static void oop_copy_one(zpointer* dst, zpointer* src);
 86 
 87     static bool oop_arraycopy_in_heap_check_cast(zpointer* dst, zpointer* src, size_t length, Klass* dst_klass);
 88     static bool oop_arraycopy_in_heap_no_check_cast(zpointer* dst, zpointer* src, size_t length);
 89 
 90   public:
 91     //
 92     // In heap
 93     //
 94     static oop oop_load_in_heap(zpointer* p);
 95     static oop oop_load_in_heap(oop* p)       { return oop_load_in_heap((zpointer*)p); };
 96     static oop oop_load_in_heap(narrowOop* p) { unsupported(); return nullptr; }
 97 
 98     static oop oop_load_in_heap_at(oop base, ptrdiff_t offset);
 99 
100     static void oop_store_in_heap(zpointer* p, oop value);
101     static void oop_store_in_heap(oop* p, oop value)       { oop_store_in_heap((zpointer*)p, value); }
102     static void oop_store_in_heap(narrowOop* p, oop value) { unsupported(); }
103     static void oop_store_in_heap_at(oop base, ptrdiff_t offset, oop value);
104 
105     static void oop_store_not_in_heap(zpointer* p, oop value);
106     static void oop_store_not_in_heap(oop* p, oop value)       { oop_store_not_in_heap((zpointer*)p, value); }
107     static void oop_store_not_in_heap(narrowOop* p, oop value) { unsupported(); }
108     static void oop_store_not_in_heap_at(oop base, ptrdiff_t offset, oop value);
109 
110     static oop oop_atomic_cmpxchg_in_heap(zpointer* p, oop compare_value, oop new_value);
111     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); }
112     static oop oop_atomic_cmpxchg_in_heap(narrowOop* p, oop compare_value, oop new_value) { unsupported(); return nullptr; }
113     static oop oop_atomic_cmpxchg_in_heap_at(oop base, ptrdiff_t offset, oop compare_value, oop new_value);
114 
115     static oop oop_atomic_xchg_in_heap(zpointer* p, oop new_value);
116     static oop oop_atomic_xchg_in_heap(oop* p, oop new_value)       { return oop_atomic_xchg_in_heap((zpointer*)p, new_value); }
117     static oop oop_atomic_xchg_in_heap(narrowOop* p, oop new_value) { unsupported(); return nullptr; }
118     static oop oop_atomic_xchg_in_heap_at(oop base, ptrdiff_t offset, oop new_value);
119 
120     static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, zpointer* src_raw,
121                                       arrayOop dst_obj, size_t dst_offset_in_bytes, zpointer* dst_raw,
122                                       size_t length);
123     static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, oop* src_raw,
124                                       arrayOop dst_obj, size_t dst_offset_in_bytes, oop* dst_raw,
125                                       size_t length) {
126       return oop_arraycopy_in_heap(src_obj, src_offset_in_bytes, (zpointer*)src_raw,
127                                    dst_obj, dst_offset_in_bytes, (zpointer*)dst_raw,
128                                    length);
129     }
130     static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, narrowOop* src_raw,
131                                       arrayOop dst_obj, size_t dst_offset_in_bytes, narrowOop* dst_raw,
132                                       size_t length) { unsupported(); return false; }
133 
134     static void clone_in_heap(oop src, oop dst, size_t size);
135 
136     //
137     // Not in heap
138     //
139     static oop oop_load_not_in_heap(zpointer* p);
140     static oop oop_load_not_in_heap(oop* p);
141     static oop oop_load_not_in_heap(narrowOop* p) { unsupported(); return nullptr; }
142 
143     static oop oop_atomic_cmpxchg_not_in_heap(zpointer* p, oop compare_value, oop new_value);
144     static oop oop_atomic_cmpxchg_not_in_heap(oop* p, oop compare_value, oop new_value) {
145       return oop_atomic_cmpxchg_not_in_heap((zpointer*)p, compare_value, new_value);
146     }
147     static oop oop_atomic_cmpxchg_not_in_heap(narrowOop* addr, oop compare_value, oop new_value) { unsupported(); return nullptr; }
148 
149     static oop oop_atomic_xchg_not_in_heap(zpointer* p, oop new_value);
150     static oop oop_atomic_xchg_not_in_heap(oop* p, oop new_value)       { return oop_atomic_xchg_not_in_heap((zpointer*)p, new_value); }
151     static oop oop_atomic_xchg_not_in_heap(narrowOop* p, oop new_value) { unsupported(); return nullptr; }
152   };
153 };
154 
155 template<> struct BarrierSet::GetName<ZBarrierSet> {
156   static const BarrierSet::Name value = BarrierSet::ZBarrierSet;
157 };
158 
159 template<> struct BarrierSet::GetType<BarrierSet::ZBarrierSet> {
160   typedef ::ZBarrierSet type;
161 };
162 
163 #endif // SHARE_GC_Z_ZBARRIERSET_HPP