src/hotspot/share/gc/z/zIndexDistributor.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_ZINDEXDISTRIBUTOR_HPP
#define SHARE_GC_Z_ZINDEXDISTRIBUTOR_HPP

#include <utilities/globalDefinitions.hpp>

class ZIndexDistributor {
private:
  void* _strategy;

  template <typename Strategy>
  Strategy* strategy();

  static void* create_strategy(int count);

public:
  ZIndexDistributor(int count);
  ~ZIndexDistributor();

  template <typename Function>
  void do_indices(Function function);

  // Returns a count that is max_count or larger and upholds the requirements
  // for using the ZIndexDistributor strategy specfied by ZIndexDistributorStrategy
  static size_t get_count(size_t max_count);
};

#endif // SHARE_GC_Z_ZINDEXDISTRIBUTOR_HPP