src/hotspot/share/gc/z/zRememberedSet.inline.hpp

/*
 * Copyright (c) 2021, 2023, 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_Z_ZREMEMBEREDSET_INLINE_HPP
#define SHARE_GC_Z_ZREMEMBEREDSET_INLINE_HPP

#include "gc/z/zRememberedSet.hpp"

#include "utilities/bitMap.inline.hpp"

inline CHeapBitMap* ZRememberedSet::current() {
  return &_bitmap[_current];
}

inline const CHeapBitMap* ZRememberedSet::current() const {
  return &_bitmap[_current];
}

inline CHeapBitMap* ZRememberedSet::previous() {
  return &_bitmap[_current ^ 1];
}

inline const CHeapBitMap* ZRememberedSet::previous() const {
  return &_bitmap[_current ^ 1];
}

inline uintptr_t ZRememberedSet::to_offset(BitMap::idx_t index) {
  // One bit per possible oop* address
  return index * oopSize;
}

inline BitMap::idx_t ZRememberedSet::to_index(uintptr_t offset) {
  // One bit per possible oop* address
  return offset / oopSize;
}

inline BitMap::idx_t ZRememberedSet::to_bit_size(size_t size) {
  return size / oopSize;
}

inline bool ZRememberedSet::at_current(uintptr_t offset) const {
  const BitMap::idx_t index = to_index(offset);
  return current()->at(index);
}

inline bool ZRememberedSet::at_previous(uintptr_t offset) const {
  const BitMap::idx_t index = to_index(offset);
  return previous()->at(index);
}

inline bool ZRememberedSet::set_current(uintptr_t offset) {
  const BitMap::idx_t index = to_index(offset);
  return current()->par_set_bit(index, memory_order_relaxed);
}

inline void ZRememberedSet::unset_non_par_current(uintptr_t offset) {
  const BitMap::idx_t index = to_index(offset);
  current()->clear_bit(index);
}

inline void ZRememberedSet::unset_range_non_par_current(uintptr_t offset, size_t size) {
  const BitMap::idx_t start_index = to_index(offset);
  const BitMap::idx_t end_index = to_index(offset + size);
  current()->clear_range(start_index, end_index);
}

template <typename Function>
void ZRememberedSet::iterate_bitmap(Function function, CHeapBitMap* bitmap) {
  bitmap->iterate([&](BitMap::idx_t index) {
    const uintptr_t offset = to_offset(index);

    function(offset);

    return true;
  });
}

template <typename Function>
void ZRememberedSet::iterate_previous(Function function) {
  iterate_bitmap(function, previous());
}

template <typename Function>
void ZRememberedSet::iterate_current(Function function) {
  iterate_bitmap(function, current());
}

#endif // SHARE_GC_Z_ZREMEMBEREDSET_INLINE_HPP