1 /*
   2  * Copyright (c) 2013, 2019, Red Hat, Inc. All rights reserved.
   3  *
   4  * This code is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License version 2 only, as
   6  * published by the Free Software Foundation.
   7  *
   8  * This code is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  11  * version 2 for more details (a copy is included in the LICENSE file that
  12  * accompanied this code).
  13  *
  14  * You should have received a copy of the GNU General Public License version
  15  * 2 along with this work; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  17  *
  18  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  19  * or visit www.oracle.com if you need additional information or have any
  20  * questions.
  21  *
  22  */
  23 
  24 #ifndef SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP
  25 #define SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP
  26 
  27 #include "gc/shared/accessBarrierSupport.hpp"
  28 #include "gc/shared/barrierSet.hpp"
  29 #include "gc/shenandoah/shenandoahHeap.hpp"
  30 #include "gc/shenandoah/shenandoahSATBMarkQueueSet.hpp"
  31 
  32 class ShenandoahBarrierSetAssembler;
  33 
  34 class ShenandoahBarrierSet: public BarrierSet {
  35 public:
  36   enum ArrayCopyStoreValMode {
  37     NONE,
  38     RESOLVE_BARRIER,
  39     EVAC_BARRIER
  40   };
  41 private:
  42 
  43   ShenandoahHeap* _heap;
  44   BufferNode::Allocator _satb_mark_queue_buffer_allocator;
  45   ShenandoahSATBMarkQueueSet _satb_mark_queue_set;
  46 
  47 public:
  48   ShenandoahBarrierSet(ShenandoahHeap* heap);
  49 
  50   static ShenandoahBarrierSetAssembler* assembler();
  51 
  52   inline static ShenandoahBarrierSet* barrier_set() {
  53     return barrier_set_cast<ShenandoahBarrierSet>(BarrierSet::barrier_set());
  54   }
  55 
  56   static ShenandoahSATBMarkQueueSet& satb_mark_queue_set() {
  57     return barrier_set()->_satb_mark_queue_set;
  58   }
  59 
  60   static bool need_load_reference_barrier(DecoratorSet decorators, BasicType type);
  61   static bool use_load_reference_barrier_native(DecoratorSet decorators, BasicType type);
  62   static bool need_keep_alive_barrier(DecoratorSet decorators, BasicType type);
  63 
  64   void print_on(outputStream* st) const;
  65 
  66   bool is_a(BarrierSet::Name bsn);
  67 
  68   bool is_aligned(HeapWord* hw);
  69 
  70   template <class T> void
  71   write_ref_array_pre_work(T* src, T* dst, size_t count, bool dest_uninitialized);
  72 
  73   inline void arraycopy_pre(oop* src, oop* dst, size_t count);
  74   inline void arraycopy_pre(narrowOop* src, narrowOop* dst, size_t count);
  75   inline void arraycopy_update(oop* src, size_t count);
  76   inline void arraycopy_update(narrowOop* src, size_t count);
  77   inline void clone_barrier(oop src);
  78   void clone_barrier_runtime(oop src);
  79 
  80   // We export this to make it available in cases where the static
  81   // type of the barrier set is known.  Note that it is non-virtual.
  82   template <class T> inline void inline_write_ref_field_pre(T* field, oop new_val);
  83 
  84   // These are the more general virtual versions.
  85   void write_ref_field_pre_work(oop* field, oop new_val);
  86   void write_ref_field_pre_work(narrowOop* field, oop new_val);
  87   void write_ref_field_pre_work(void* field, oop new_val);
  88 
  89   void write_ref_field_work(void* v, oop o, bool release = false);
  90 
  91   virtual void on_thread_create(Thread* thread);
  92   virtual void on_thread_destroy(Thread* thread);
  93   virtual void on_thread_attach(Thread* thread);
  94   virtual void on_thread_detach(Thread* thread);
  95 
  96   static inline oop resolve_forwarded_not_null(oop p);
  97   static inline oop resolve_forwarded(oop p);
  98 
  99   void storeval_barrier(oop obj);
 100   void keep_alive_barrier(oop obj);
 101 
 102   oop load_reference_barrier(oop obj);
 103   oop load_reference_barrier_not_null(oop obj);
 104 
 105   oop load_reference_barrier_mutator(oop obj, oop* load_addr);
 106   oop load_reference_barrier_mutator(oop obj, narrowOop* load_addr);
 107 
 108   template <class T>
 109   oop load_reference_barrier_mutator_work(oop obj, T* load_addr);
 110 
 111   oop load_reference_barrier_native(oop obj, oop* load_addr);
 112   oop load_reference_barrier_native(oop obj, narrowOop* load_addr);
 113 
 114   void enqueue(oop obj);
 115 
 116 private:
 117   template <class T>
 118   inline void arraycopy_pre_work(T* src, T* dst, size_t count);
 119   template <class T, bool HAS_FWD, bool EVAC, bool ENQUEUE>
 120   inline void arraycopy_work(T* src, size_t count);
 121   template <class T>
 122   inline void arraycopy_update_impl(T* src, size_t count);
 123 
 124   oop load_reference_barrier_impl(oop obj);
 125 
 126   template <class T>
 127   oop load_reference_barrier_native_impl(oop obj, T* load_addr);
 128 
 129   static void keep_alive_if_weak(DecoratorSet decorators, oop value) {
 130     assert((decorators & ON_UNKNOWN_OOP_REF) == 0, "Reference strength must be known");
 131     const bool on_strong_oop_ref = (decorators & ON_STRONG_OOP_REF) != 0;
 132     const bool peek              = (decorators & AS_NO_KEEPALIVE) != 0;
 133     if (!peek && !on_strong_oop_ref && value != NULL) {
 134       ShenandoahBarrierSet::barrier_set()->keep_alive_barrier(value);
 135     }
 136   }
 137 
 138 public:
 139   // Callbacks for runtime accesses.
 140   template <DecoratorSet decorators, typename BarrierSetT = ShenandoahBarrierSet>
 141   class AccessBarrier: public BarrierSet::AccessBarrier<decorators, BarrierSetT> {
 142     typedef BarrierSet::AccessBarrier<decorators, BarrierSetT> Raw;
 143 
 144     template <typename T>
 145     static oop oop_atomic_cmpxchg_in_heap_impl(oop new_value, T* addr, oop compare_value);
 146 
 147     template <typename T>
 148     static oop oop_atomic_xchg_in_heap_impl(oop new_value, T* addr);
 149 
 150   public:
 151     // Heap oop accesses. These accessors get resolved when
 152     // IN_HEAP is set (e.g. when using the HeapAccess API), it is
 153     // an oop_* overload, and the barrier strength is AS_NORMAL.
 154     template <typename T>
 155     static oop oop_load_in_heap(T* addr);
 156     static oop oop_load_in_heap_at(oop base, ptrdiff_t offset);
 157 
 158     template <typename T>
 159     static void oop_store_in_heap(T* addr, oop value);
 160     static void oop_store_in_heap_at(oop base, ptrdiff_t offset, oop value);
 161 
 162     template <typename T>
 163     static oop oop_atomic_cmpxchg_in_heap(oop new_value, T* addr, oop compare_value);
 164     static oop oop_atomic_cmpxchg_in_heap_at(oop new_value, oop base, ptrdiff_t offset, oop compare_value);
 165 
 166     template <typename T>
 167     static oop oop_atomic_xchg_in_heap(oop new_value, T* addr);
 168     static oop oop_atomic_xchg_in_heap_at(oop new_value, oop base, ptrdiff_t offset);
 169 
 170     template <typename T>
 171     static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, T* src_raw,
 172                                       arrayOop dst_obj, size_t dst_offset_in_bytes, T* dst_raw,
 173                                       size_t length);
 174 
 175     // Clone barrier support
 176     static void clone_in_heap(oop src, oop dst, size_t size);
 177 
 178     // Needed for loads on non-heap weak references
 179     template <typename T>
 180     static oop oop_load_not_in_heap(T* addr);
 181 
 182     // Used for catching bad stores
 183     template <typename T>
 184     static void oop_store_not_in_heap(T* addr, oop value);
 185 
 186     template <typename T>
 187     static oop oop_atomic_cmpxchg_not_in_heap(oop new_value, T* addr, oop compare_value);
 188 
 189     template <typename T>
 190     static oop oop_atomic_xchg_not_in_heap(oop new_value, T* addr);
 191 
 192   };
 193 
 194 };
 195 
 196 template<>
 197 struct BarrierSet::GetName<ShenandoahBarrierSet> {
 198   static const BarrierSet::Name value = BarrierSet::ShenandoahBarrierSet;
 199 };
 200 
 201 template<>
 202 struct BarrierSet::GetType<BarrierSet::ShenandoahBarrierSet> {
 203   typedef ::ShenandoahBarrierSet type;
 204 };
 205 
 206 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP
--- EOF ---