/*

 * Copyright (c) 2005, 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_PARALLEL_PSCOMPACTIONMANAGER_HPP

#define SHARE_GC_PARALLEL_PSCOMPACTIONMANAGER_HPP

#include "gc/shared/taskqueue.hpp"

#include "memory/allocation.hpp"

#include "utilities/stack.hpp"

class MutableSpace;

class PSOldGen;

class ParCompactionManager;

class ObjectStartArray;

class ParallelCompactData;

class ParMarkBitMap;

class ParCompactionManager : public CHeapObj<mtGC> {

  friend class ParallelTaskTerminator;

  friend class ParMarkBitMap;

  friend class PSParallelCompact;

  friend class CompactionWithStealingTask;

  friend class UpdateAndFillClosure;

  friend class RefProcTaskExecutor;

  friend class PCRefProcTask;

  friend class MarkFromRootsTask;

  friend class UpdateDensePrefixAndCompactionTask;

 public:

// ------------------------  Don't putback if not needed

  // Actions that the compaction manager should take.

  enum Action {

    Update,

    Copy,

    UpdateAndCopy,

    CopyAndUpdate,

    NotValid

  };

// ------------------------  End don't putback if not needed

 private:

  // 32-bit:  4K * 8 = 32KiB; 64-bit:  8K * 16 = 128KiB

  #define QUEUE_SIZE (1 << NOT_LP64(12) LP64_ONLY(13))

  typedef OverflowTaskQueue<ObjArrayTask, mtGC, QUEUE_SIZE> ObjArrayTaskQueue;

  typedef GenericTaskQueueSet<ObjArrayTaskQueue, mtGC>      ObjArrayTaskQueueSet;

  #undef QUEUE_SIZE

  static ParCompactionManager** _manager_array;

  static OopTaskQueueSet*       _stack_array;

  static ObjArrayTaskQueueSet*  _objarray_queues;

  static ObjectStartArray*      _start_array;

  static RegionTaskQueueSet*    _region_array;

  static PSOldGen*              _old_gen;

private:

  OverflowTaskQueue<oop, mtGC>        _marking_stack;

  ObjArrayTaskQueue             _objarray_stack;

  // Is there a way to reuse the _marking_stack for the

  // saving empty regions?  For now just create a different

  // type of TaskQueue.

  RegionTaskQueue              _region_stack;

  static ParMarkBitMap* _mark_bitmap;

  Action _action;

  HeapWord* _last_query_beg;

  oop _last_query_obj;

  size_t _last_query_ret;

  static PSOldGen* old_gen()             { return _old_gen; }

  static ObjectStartArray* start_array() { return _start_array; }

  static OopTaskQueueSet* stack_array()  { return _stack_array; }

  static void initialize(ParMarkBitMap* mbm);

 protected:

  // Array of tasks.  Needed by the ParallelTaskTerminator.

  static RegionTaskQueueSet* region_array()      { return _region_array; }

  OverflowTaskQueue<oop, mtGC>*  marking_stack()       { return &_marking_stack; }

  // Pushes onto the marking stack.  If the marking stack is full,

  // pushes onto the overflow stack.

  void stack_push(oop obj);

  // Do not implement an equivalent stack_pop.  Deal with the

  // marking stack and overflow stack directly.

 public:

  void reset_bitmap_query_cache() {

    _last_query_beg = NULL;

    _last_query_obj = NULL;

    _last_query_ret = 0;

  }

  Action action() { return _action; }

  void set_action(Action v) { _action = v; }

  // Bitmap query support, cache last query and result

  HeapWord* last_query_begin() { return _last_query_beg; }

  oop last_query_object() { return _last_query_obj; }

  size_t last_query_return() { return _last_query_ret; }

  void set_last_query_begin(HeapWord *new_beg) { _last_query_beg = new_beg; }

  void set_last_query_object(oop new_obj) { _last_query_obj = new_obj; }

  void set_last_query_return(size_t new_ret) { _last_query_ret = new_ret; }

  static void reset_all_bitmap_query_caches();

  RegionTaskQueue* region_stack()                { return &_region_stack; }

  inline static ParCompactionManager* manager_array(uint index);

  ParCompactionManager();

  // Pushes onto the region stack at the given index.  If the

  // region stack is full,

  // pushes onto the region overflow stack.

  static void verify_region_list_empty(uint stack_index);

  ParMarkBitMap* mark_bitmap() { return _mark_bitmap; }

  // void drain_stacks();

  bool should_update();

  bool should_copy();

  // Save for later processing.  Must not fail.

  inline void push(oop obj);

  inline void push_objarray(oop objarray, size_t index);

  inline void push_region(size_t index);

  // Check mark and maybe push on marking stack.

  template <typename T> inline void mark_and_push(T* p);

  inline void follow_klass(Klass* klass);

  void follow_class_loader(ClassLoaderData* klass);

  // Access function for compaction managers

  static ParCompactionManager* gc_thread_compaction_manager(uint index);

  static bool steal(int queue_num, oop& t);

  static bool steal_objarray(int queue_num, ObjArrayTask& t);

  static bool steal(int queue_num, size_t& region);

  // Process tasks remaining on any marking stack

  void follow_marking_stacks();

  inline bool marking_stacks_empty() const;

  // Process tasks remaining on any stack

  void drain_region_stacks();

  void follow_contents(oop obj);

  void follow_array(objArrayOop array, int index);

  void update_contents(oop obj);

  class FollowStackClosure: public VoidClosure {

   private:

    ParCompactionManager* _compaction_manager;

   public:

    FollowStackClosure(ParCompactionManager* cm) : _compaction_manager(cm) { }

    virtual void do_void();

  };

};

inline ParCompactionManager* ParCompactionManager::manager_array(uint index) {

  assert(_manager_array != NULL, "access of NULL manager_array");

  assert(index <= ParallelGCThreads, "out of range manager_array access");

  return _manager_array[index];

}

bool ParCompactionManager::marking_stacks_empty() const {

  return _marking_stack.is_empty() && _objarray_stack.is_empty();

}

#endif // SHARE_GC_PARALLEL_PSCOMPACTIONMANAGER_HPP