/*

 * Copyright (c) 2001, 2015, 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_VM_GC_PARALLEL_PSMARKSWEEPDECORATOR_HPP

#define SHARE_VM_GC_PARALLEL_PSMARKSWEEPDECORATOR_HPP

#include "gc/parallel/mutableSpace.hpp"

//

// A PSMarkSweepDecorator is used to add "ParallelScavenge" style mark sweep operations

// to a MutableSpace.

//

class ObjectStartArray;

class PSMarkSweepDecorator: public CHeapObj<mtGC> {

 private:

  static PSMarkSweepDecorator* _destination_decorator;

 protected:

  MutableSpace* _space;

  ObjectStartArray* _start_array;

  HeapWord* _first_dead;

  HeapWord* _end_of_live;

  HeapWord* _compaction_top;

  size_t _allowed_dead_ratio;

  bool insert_deadspace(size_t& allowed_deadspace_words, HeapWord* q,

                        size_t word_len);

 public:

  PSMarkSweepDecorator(MutableSpace* space, ObjectStartArray* start_array,

                       size_t allowed_dead_ratio) :

    _space(space), _start_array(start_array),

    _allowed_dead_ratio(allowed_dead_ratio) { }

  // During a compacting collection, we need to collapse objects into

  // spaces in a given order. We want to fill space A, space B, and so

  // on. The code that controls that order is in the following methods.

  static void set_destination_decorator_tenured();

  static void advance_destination_decorator();

  static PSMarkSweepDecorator* destination_decorator();

  // Accessors

  MutableSpace* space()                     { return _space; }

  ObjectStartArray* start_array()           { return _start_array; }

  HeapWord* compaction_top()                { return _compaction_top; }

  void set_compaction_top(HeapWord* value)  { _compaction_top = value; }

  size_t allowed_dead_ratio()               { return _allowed_dead_ratio; }

  void set_allowed_dead_ratio(size_t value) { _allowed_dead_ratio = value; }

  // Work methods

  void adjust_pointers();

  void precompact();

  void compact(bool mangle_free_space);

};

#endif // SHARE_VM_GC_PARALLEL_PSMARKSWEEPDECORATOR_HPP