src/hotspot/share/gc/z/zThreadLocalData.hpp

/*
 * Copyright (c) 2018, 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_ZTHREADLOCALDATA_HPP
#define SHARE_GC_Z_ZTHREADLOCALDATA_HPP

#include "gc/z/zAddress.hpp"
#include "gc/z/zGenerationId.hpp"
#include "gc/z/zMarkStack.hpp"
#include "gc/z/zStoreBarrierBuffer.hpp"
#include "runtime/javaThread.hpp"
#include "utilities/debug.hpp"
#include "utilities/sizes.hpp"

class ZThreadLocalData {
private:
  uintptr_t              _load_good_mask;
  uintptr_t              _load_bad_mask;
  uintptr_t              _mark_bad_mask;
  uintptr_t              _store_good_mask;
  uintptr_t              _store_bad_mask;
  uintptr_t              _uncolor_mask;
  uintptr_t              _nmethod_disarmed;
  ZStoreBarrierBuffer*   _store_barrier_buffer;
  ZMarkThreadLocalStacks _mark_stacks[2];
  zaddress_unsafe*       _invisible_root;

  ZThreadLocalData()
    : _load_good_mask(0),
      _load_bad_mask(0),
      _mark_bad_mask(0),
      _store_good_mask(0),
      _store_bad_mask(0),
      _uncolor_mask(0),
      _nmethod_disarmed(0),
      _store_barrier_buffer(new ZStoreBarrierBuffer()),
      _mark_stacks(),
      _invisible_root(nullptr) {}

  ~ZThreadLocalData() {
    delete _store_barrier_buffer;
  }

  static ZThreadLocalData* data(Thread* thread) {
    return thread->gc_data<ZThreadLocalData>();
  }

public:
  static void create(Thread* thread) {
    new (data(thread)) ZThreadLocalData();
  }

  static void destroy(Thread* thread) {
    data(thread)->~ZThreadLocalData();
  }

  static void set_load_bad_mask(Thread* thread, uintptr_t mask) {
    data(thread)->_load_bad_mask = mask;
  }

  static void set_mark_bad_mask(Thread* thread, uintptr_t mask) {
    data(thread)->_mark_bad_mask = mask;
  }

  static void set_store_bad_mask(Thread* thread, uintptr_t mask) {
    data(thread)->_store_bad_mask = mask;
  }

  static void set_load_good_mask(Thread* thread, uintptr_t mask) {
    data(thread)->_load_good_mask = mask;
  }

  static void set_store_good_mask(Thread* thread, uintptr_t mask) {
    data(thread)->_store_good_mask = mask;
  }

  static void set_nmethod_disarmed(Thread* thread, uintptr_t value) {
    data(thread)->_nmethod_disarmed = value;
  }

  static ZMarkThreadLocalStacks* mark_stacks(Thread* thread, ZGenerationId id) {
    return &data(thread)->_mark_stacks[(int)id];
  }

  static ZStoreBarrierBuffer* store_barrier_buffer(Thread* thread) {
    return data(thread)->_store_barrier_buffer;
  }

  static void set_invisible_root(Thread* thread, zaddress_unsafe* root) {
    assert(data(thread)->_invisible_root == nullptr, "Already set");
    data(thread)->_invisible_root = root;
  }

  static void clear_invisible_root(Thread* thread) {
    assert(data(thread)->_invisible_root != nullptr, "Should be set");
    data(thread)->_invisible_root = nullptr;
  }

  static zaddress_unsafe* invisible_root(Thread* thread) {
    return data(thread)->_invisible_root;
  }

  static ByteSize load_bad_mask_offset() {
    return Thread::gc_data_offset() + byte_offset_of(ZThreadLocalData, _load_bad_mask);
  }

  static ByteSize mark_bad_mask_offset() {
    return Thread::gc_data_offset() + byte_offset_of(ZThreadLocalData, _mark_bad_mask);
  }

  static ByteSize store_bad_mask_offset() {
    return Thread::gc_data_offset() + byte_offset_of(ZThreadLocalData, _store_bad_mask);
  }

  static ByteSize store_good_mask_offset() {
    return Thread::gc_data_offset() + byte_offset_of(ZThreadLocalData, _store_good_mask);
  }

  static ByteSize nmethod_disarmed_offset() {
    return Thread::gc_data_offset() + byte_offset_of(ZThreadLocalData, _nmethod_disarmed);
  }

  static ByteSize store_barrier_buffer_offset() {
    return Thread::gc_data_offset() + byte_offset_of(ZThreadLocalData, _store_barrier_buffer);
  }
};

#endif // SHARE_GC_Z_ZTHREADLOCALDATA_HPP