/*

 * Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * 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_G1_G1BARRIERSET_HPP

#define SHARE_GC_G1_G1BARRIERSET_HPP

#include "gc/g1/g1DirtyCardQueue.hpp"

#include "gc/g1/g1SATBMarkQueueSet.hpp"

#include "gc/g1/g1SharedDirtyCardQueue.hpp"

#include "gc/shared/cardTable.hpp"

#include "gc/shared/cardTableBarrierSet.hpp"

class G1CardTable;

// This barrier is specialized to use a logging barrier to support

// snapshot-at-the-beginning marking.

class G1BarrierSet: public CardTableBarrierSet {

  friend class VMStructs;

 private:

  BufferNode::Allocator _satb_mark_queue_buffer_allocator;

  BufferNode::Allocator _dirty_card_queue_buffer_allocator;

  G1SATBMarkQueueSet _satb_mark_queue_set;

  G1DirtyCardQueueSet _dirty_card_queue_set;

  G1SharedDirtyCardQueue _shared_dirty_card_queue;

  static G1BarrierSet* g1_barrier_set() {

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

  }

 public:

  G1BarrierSet(G1CardTable* table);

  ~G1BarrierSet() { }

  // Add "pre_val" to a set of objects that may have been disconnected from the

  // pre-marking object graph.

  static void enqueue(oop pre_val);

  static void enqueue_if_weak(DecoratorSet decorators, oop value);

  template <class T> void write_ref_array_pre_work(T* dst, size_t count);

  virtual void write_ref_array_pre(oop* dst, size_t count, bool dest_uninitialized);

  virtual void write_ref_array_pre(narrowOop* dst, size_t count, bool dest_uninitialized);

  template <DecoratorSet decorators, typename T>

  void write_ref_field_pre(T* field);

  // NB: if you do a whole-heap invalidation, the "usual invariant" defined

  // above no longer applies.

  void invalidate(MemRegion mr);

  void write_region(MemRegion mr)         { invalidate(mr); }

  void write_ref_array_work(MemRegion mr) { invalidate(mr); }

  template <DecoratorSet decorators, typename T>

  void write_ref_field_post(T* field, oop new_val);

  void write_ref_field_post_slow(volatile CardValue* byte);

  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 G1SATBMarkQueueSet& satb_mark_queue_set() {

    return g1_barrier_set()->_satb_mark_queue_set;

  }

  static G1DirtyCardQueueSet& dirty_card_queue_set() {

    return g1_barrier_set()->_dirty_card_queue_set;

  }

  static G1SharedDirtyCardQueue& shared_dirty_card_queue() {

    return g1_barrier_set()->_shared_dirty_card_queue;

  }

  // Callbacks for runtime accesses.

  template <DecoratorSet decorators, typename BarrierSetT = G1BarrierSet>

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

    typedef ModRefBarrierSet::AccessBarrier<decorators, BarrierSetT> ModRef;

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

  public:

    // Needed for loads on non-heap weak references

    template <typename T>

    static oop oop_load_not_in_heap(T* addr);

    // Needed for non-heap stores

    template <typename T>

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

    // Needed for weak references

    static oop oop_load_in_heap_at(oop base, ptrdiff_t offset);

    // Defensive: will catch weak oops at addresses in heap

    template <typename T>

    static oop oop_load_in_heap(T* addr);

  };

};

template<>

struct BarrierSet::GetName<G1BarrierSet> {

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

};

template<>

struct BarrierSet::GetType<BarrierSet::G1BarrierSet> {

  typedef ::G1BarrierSet type;

};

#endif // SHARE_GC_G1_G1BARRIERSET_HPP