/*

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

 *

 */

#include "gc/parallel/parMarkBitMap.hpp"

#include "utilities/bitMap.inline.hpp"

inline ParMarkBitMap::ParMarkBitMap():

  _region_start(NULL), _region_size(0), _beg_bits(), _end_bits(), _virtual_space(NULL), _reserved_byte_size(0)

{ }

inline void ParMarkBitMap::clear_range(idx_t beg, idx_t end) {

  _beg_bits.clear_range(beg, end);

  _end_bits.clear_range(beg, end);

}

inline ParMarkBitMap::idx_t ParMarkBitMap::bits_required(size_t words) {

  // Need two bits (one begin bit, one end bit) for each unit of 'object

  // granularity' in the heap.

  return words_to_bits(words * 2);

}

inline ParMarkBitMap::idx_t ParMarkBitMap::bits_required(MemRegion covered_region) {

  return bits_required(covered_region.word_size());

}

inline HeapWord* ParMarkBitMap::region_start() const {

  return _region_start;

}

inline HeapWord* ParMarkBitMap::region_end() const {

  return region_start() + region_size();

}

inline size_t ParMarkBitMap::region_size() const {

  return _region_size;

}

inline size_t ParMarkBitMap::size() const {

  return _beg_bits.size();

}

inline bool ParMarkBitMap::is_obj_beg(idx_t bit) const {

  return _beg_bits.at(bit);

}

inline bool ParMarkBitMap::is_obj_end(idx_t bit) const {

  return _end_bits.at(bit);

}

inline bool ParMarkBitMap::is_marked(idx_t bit) const {

  return is_obj_beg(bit);

}

inline bool ParMarkBitMap::is_marked(HeapWord* addr) const {

  return is_marked(addr_to_bit(addr));

}

inline bool ParMarkBitMap::is_marked(oop obj) const {

  return is_marked((HeapWord*)obj);

}

inline bool ParMarkBitMap::is_unmarked(idx_t bit) const {

  return !is_marked(bit);

}

inline bool ParMarkBitMap::is_unmarked(HeapWord* addr) const {

  return !is_marked(addr);

}

inline bool ParMarkBitMap::is_unmarked(oop obj) const {

  return !is_marked(obj);

}

inline size_t ParMarkBitMap::bits_to_words(idx_t bits) {

  return bits << obj_granularity_shift();

}

inline ParMarkBitMap::idx_t ParMarkBitMap::words_to_bits(size_t words) {

  return words >> obj_granularity_shift();

}

inline size_t ParMarkBitMap::obj_size(idx_t beg_bit, idx_t end_bit) const {

  DEBUG_ONLY(verify_bit(beg_bit);)

  DEBUG_ONLY(verify_bit(end_bit);)

  return bits_to_words(end_bit - beg_bit + 1);

}

inline size_t ParMarkBitMap::obj_size(HeapWord* beg_addr, HeapWord* end_addr) const {

  DEBUG_ONLY(verify_addr(beg_addr);)

  DEBUG_ONLY(verify_addr(end_addr);)

  return pointer_delta(end_addr, beg_addr) + obj_granularity();

}

inline size_t ParMarkBitMap::obj_size(idx_t beg_bit) const {

  const idx_t end_bit = _end_bits.get_next_one_offset(beg_bit, size());

  assert(is_marked(beg_bit), "obj not marked");

  assert(end_bit < size(), "end bit missing");

  return obj_size(beg_bit, end_bit);

}

inline size_t ParMarkBitMap::obj_size(HeapWord* addr) const {

  return obj_size(addr_to_bit(addr));

}

inline ParMarkBitMap::IterationStatus ParMarkBitMap::iterate(ParMarkBitMapClosure* live_closure,

                                                             HeapWord* range_beg,

                                                             HeapWord* range_end) const {

  return iterate(live_closure, addr_to_bit(range_beg), addr_to_bit(range_end));

}

inline ParMarkBitMap::IterationStatus ParMarkBitMap::iterate(ParMarkBitMapClosure* live_closure,

                                                             ParMarkBitMapClosure* dead_closure,

                                                             HeapWord* range_beg,

                                                             HeapWord* range_end,

                                                             HeapWord* dead_range_end) const {

  return iterate(live_closure, dead_closure,

                 addr_to_bit(range_beg), addr_to_bit(range_end),

                 addr_to_bit(dead_range_end));

}

inline bool ParMarkBitMap::mark_obj(oop obj, int size) {

  return mark_obj((HeapWord*)obj, (size_t)size);

}

inline BitMap::idx_t ParMarkBitMap::addr_to_bit(HeapWord* addr) const {

  DEBUG_ONLY(verify_addr(addr);)

  return words_to_bits(pointer_delta(addr, region_start()));

}

inline HeapWord* ParMarkBitMap::bit_to_addr(idx_t bit) const {

  DEBUG_ONLY(verify_bit(bit);)

  return region_start() + bits_to_words(bit);

}

inline ParMarkBitMap::idx_t ParMarkBitMap::find_obj_beg(idx_t beg, idx_t end) const {

  return _beg_bits.get_next_one_offset_aligned_right(beg, end);

}

inline ParMarkBitMap::idx_t ParMarkBitMap::find_obj_end(idx_t beg, idx_t end) const {

  return _end_bits.get_next_one_offset_aligned_right(beg, end);

}

inline HeapWord* ParMarkBitMap::find_obj_beg(HeapWord* beg, HeapWord* end) const {

  const idx_t beg_bit = addr_to_bit(beg);

  const idx_t end_bit = addr_to_bit(end);

  const idx_t search_end = BitMap::word_align_up(end_bit);

  const idx_t res_bit = MIN2(find_obj_beg(beg_bit, search_end), end_bit);

  return bit_to_addr(res_bit);

}

inline HeapWord* ParMarkBitMap::find_obj_end(HeapWord* beg, HeapWord* end) const {

  const idx_t beg_bit = addr_to_bit(beg);

  const idx_t end_bit = addr_to_bit(end);

  const idx_t search_end = BitMap::word_align_up(end_bit);

  const idx_t res_bit = MIN2(find_obj_end(beg_bit, search_end), end_bit);

  return bit_to_addr(res_bit);

}

#ifdef  ASSERT

inline void ParMarkBitMap::verify_bit(idx_t bit) const {

  // Allow one past the last valid bit; useful for loop bounds.

  assert(bit <= _beg_bits.size(), "bit out of range");

}

inline void ParMarkBitMap::verify_addr(HeapWord* addr) const {

  // Allow one past the last valid address; useful for loop bounds.

  assert(addr >= region_start(),

         "addr too small, addr: " PTR_FORMAT " region start: " PTR_FORMAT, p2i(addr), p2i(region_start()));

  assert(addr <= region_end(),

         "addr too big, addr: " PTR_FORMAT " region end: " PTR_FORMAT, p2i(addr), p2i(region_end()));

}

#endif  // #ifdef ASSERT