instance.hpp

Go to the documentation of this file.

/*
 *   Copyright 2025 Huawei Technologies Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <mpi.h>
#include <hicr/core/instance.hpp>
 
namespace HiCR::backend::mpi
{
 
constexpr int _HICR_MPI_INSTANCE_ROOT_ID = 0;
 
class Instance final : public HiCR::Instance
{
  public:
 
  Instance(const int rank)
    : HiCR::Instance((instanceId_t)rank),
      _rank(rank)
  {}
 
  ~Instance() override = default;
 
  [[nodiscard]] bool isRootInstance() const override
  {
    // Criterion for root rank in MPI: Rank 0 will always be the root.
    return _rank == _HICR_MPI_INSTANCE_ROOT_ID;
  };
 
  [[nodiscard]] __INLINE__ int getRank() const { return _rank; }
 
  const int _rank;
};
 
} // namespace HiCR::backend::mpi