instanceManager.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 <memory>
#include <mpi.h>
#include <hicr/core/definitions.hpp>
#include <hicr/core/instanceManager.hpp>
#include <hicr/backends/mpi/instance.hpp>
 
namespace HiCR::backend::mpi
{
 
#ifndef _HICR_MPI_INSTANCE_BASE_TAG
  #define _HICR_MPI_INSTANCE_BASE_TAG 4096
#endif
 
#define _HICR_MPI_RPC_TAG (_HICR_MPI_INSTANCE_BASE_TAG + 1)
 
#define _HICR_MPI_INSTANCE_RETURN_SIZE_TAG (_HICR_MPI_INSTANCE_BASE_TAG + 2)
 
#define _HICR_MPI_INSTANCE_RETURN_DATA_TAG (_HICR_MPI_INSTANCE_BASE_TAG + 3)
 
class InstanceManager final : public HiCR::InstanceManager
{
  public:
 
  InstanceManager(MPI_Comm comm)
    : HiCR::InstanceManager(),
      _comm(comm)
  {
    // Getting current rank within and size of communicator
    MPI_Comm_size(_comm, &_size);
    MPI_Comm_rank(_comm, &_rank);
 
    // In MPI, the initial set of processes represents all the currently available instances of HiCR
    for (int i = 0; i < _size; i++)
    {
      // Creating new MPI-based HiCR instance
      auto instance = std::make_shared<HiCR::backend::mpi::Instance>(i);
 
      // If this is the current rank, set it as current instance
      if (i == _rank) setCurrentInstance(instance);
 
      // Adding instance to the collection
      addInstance(instance);
    }
  }
 
  ~InstanceManager() override = default;
 
  __INLINE__ void finalize() override { MPI_Finalize(); }
 
  __INLINE__ void abort(int errorCode) override { MPI_Abort(MPI_COMM_WORLD, errorCode); }
 
  __INLINE__ static std::unique_ptr<HiCR::InstanceManager> createDefault(int *argc, char ***argv)
  {
    // Initializing MPI
    int initialized = 0;
    MPI_Initialized(&initialized);
    if (initialized == 0)
    {
      int requested = MPI_THREAD_SINGLE;
      int provided  = 0;
      MPI_Init_thread(argc, argv, requested, &provided);
      if (provided < requested) fprintf(stderr, "Warning, your application may not work properly if MPI does not support  threaded access\n");
    }
 
    // Setting MPI_COMM_WORLD error handler
    MPI_Comm_set_errhandler(MPI_COMM_WORLD, MPI_ERRORS_RETURN);
 
    // Creating instance manager
    return std::make_unique<HiCR::backend::mpi::InstanceManager>(MPI_COMM_WORLD);
  }
 
  [[nodiscard]] __INLINE__ HiCR::Instance::instanceId_t getRootInstanceId() const override { return HiCR::backend::mpi::_HICR_MPI_INSTANCE_ROOT_ID; }
 
  private:
 
  int _RPCRequestRank = 0;
 
  const MPI_Comm _comm;
 
  int _size{};
 
  int _rank{};
};
 
} // namespace HiCR::backend::mpi