/*

 * Copyright (c) 2013, 2019, Red Hat, Inc. All rights reserved.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#ifndef SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP

#define SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP

#include "gc/shared/accessBarrierSupport.hpp"

#include "gc/shared/barrierSet.hpp"

#include "gc/shenandoah/shenandoahHeap.hpp"

#include "gc/shenandoah/shenandoahSATBMarkQueueSet.hpp"

class ShenandoahBarrierSetAssembler;

class ShenandoahBarrierSet: public BarrierSet {

public:

  enum ArrayCopyStoreValMode {

    NONE,

    RESOLVE_BARRIER,

    EVAC_BARRIER

  };

private:

  ShenandoahHeap* _heap;

  BufferNode::Allocator _satb_mark_queue_buffer_allocator;

  ShenandoahSATBMarkQueueSet _satb_mark_queue_set;

public:

  ShenandoahBarrierSet(ShenandoahHeap* heap);

  static ShenandoahBarrierSetAssembler* assembler();

  inline static ShenandoahBarrierSet* barrier_set() {

    return barrier_set_cast<ShenandoahBarrierSet>(BarrierSet::barrier_set());

  }

  static ShenandoahSATBMarkQueueSet& satb_mark_queue_set() {

    return barrier_set()->_satb_mark_queue_set;

  }

  static bool need_load_reference_barrier(DecoratorSet decorators, BasicType type);

  static bool use_load_reference_barrier_native(DecoratorSet decorators, BasicType type);

  static bool need_keep_alive_barrier(DecoratorSet decorators, BasicType type);

  void print_on(outputStream* st) const;

  bool is_a(BarrierSet::Name bsn);

  bool is_aligned(HeapWord* hw);

  template <class T> void

  write_ref_array_pre_work(T* src, T* dst, size_t count, bool dest_uninitialized);

  inline void arraycopy_pre(oop* src, oop* dst, size_t count);

  inline void arraycopy_pre(narrowOop* src, narrowOop* dst, size_t count);

  inline void arraycopy_update(oop* src, size_t count);

  inline void arraycopy_update(narrowOop* src, size_t count);

  inline void clone_barrier(oop src);

  void clone_barrier_runtime(oop src);

  virtual void on_thread_create(Thread* thread);

  virtual void on_thread_destroy(Thread* thread);

  virtual void on_thread_attach(Thread* thread);

  virtual void on_thread_detach(Thread* thread);

  static inline oop resolve_forwarded_not_null(oop p);

  static inline oop resolve_forwarded(oop p);

  oop load_reference_barrier(oop obj);

  oop load_reference_barrier_not_null(oop obj);

  oop load_reference_barrier_mutator(oop obj, oop* load_addr);

  oop load_reference_barrier_mutator(oop obj, narrowOop* load_addr);

  template <class T>

  oop load_reference_barrier_mutator_work(oop obj, T* load_addr);

  oop load_reference_barrier_native(oop obj, oop* load_addr);

  oop load_reference_barrier_native(oop obj, narrowOop* load_addr);

private:

  template <class T>

  inline void arraycopy_pre_work(T* src, T* dst, size_t count);

  template <class T, bool HAS_FWD, bool EVAC, bool ENQUEUE>

  inline void arraycopy_work(T* src, size_t count);

  template <class T>

  inline void arraycopy_update_impl(T* src, size_t count);

  oop load_reference_barrier_impl(oop obj);

  template <class T>

  oop load_reference_barrier_native_impl(oop obj, T* load_addr);

public:

  // Callbacks for runtime accesses.

  template <DecoratorSet decorators, typename BarrierSetT = ShenandoahBarrierSet>

  class AccessBarrier: public BarrierSet::AccessBarrier<decorators, BarrierSetT> {

    typedef BarrierSet::AccessBarrier<decorators, BarrierSetT> Raw;

  public:

    // Heap oop accesses. These accessors get resolved when

    // IN_HEAP is set (e.g. when using the HeapAccess API), it is

    // an oop_* overload, and the barrier strength is AS_NORMAL.

    template <typename T>

    static oop oop_load_in_heap(T* addr);

    static oop oop_load_in_heap_at(oop base, ptrdiff_t offset);

    template <typename T>

    static void oop_store_in_heap(T* addr, oop value);

    static void oop_store_in_heap_at(oop base, ptrdiff_t offset, oop value);

    template <typename T>

    static oop oop_atomic_cmpxchg_in_heap(T* addr, oop compare_value, oop new_value);

    static oop oop_atomic_cmpxchg_in_heap_at(oop base, ptrdiff_t offset, oop compare_value, oop new_value);

    template <typename T>

    static oop oop_atomic_xchg_in_heap(T* addr, oop new_value);

    static oop oop_atomic_xchg_in_heap_at(oop base, ptrdiff_t offset, oop new_value);

    template <typename T>

    static bool oop_arraycopy_in_heap(arrayOop src_obj, size_t src_offset_in_bytes, T* src_raw,

                                      arrayOop dst_obj, size_t dst_offset_in_bytes, T* dst_raw,

                                      size_t length);

    // Clone barrier support

    static void clone_in_heap(oop src, oop dst, size_t size);

    // Needed for loads on non-heap weak references

    template <typename T>

    static oop oop_load_not_in_heap(T* addr);

    // Used for catching bad stores

    template <typename T>

    static void oop_store_not_in_heap(T* addr, oop value);

    template <typename T>

    static oop oop_atomic_cmpxchg_not_in_heap(T* addr, oop compare_value, oop new_value);

    template <typename T>

    static oop oop_atomic_xchg_not_in_heap(T* addr, oop new_value);

  };

};

template<>

struct BarrierSet::GetName<ShenandoahBarrierSet> {

  static const BarrierSet::Name value = BarrierSet::ShenandoahBarrierSet;

};

template<>

struct BarrierSet::GetType<BarrierSet::ShenandoahBarrierSet> {

  typedef ::ShenandoahBarrierSet type;

};

#endif // SHARE_GC_SHENANDOAH_SHENANDOAHBARRIERSET_HPP