globalMemorySlot.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/localMemorySlot.hpp>
#include <hicr/core/globalMemorySlot.hpp>
#include <utility>
 
namespace HiCR::backend::mpi
{
 
class GlobalMemorySlot final : public HiCR::GlobalMemorySlot
{
  public:
 
  GlobalMemorySlot(int                                       rank,
                   const HiCR::GlobalMemorySlot::tag_t       globalTag             = 0,
                   const HiCR::GlobalMemorySlot::globalKey_t globalKey             = 0,
                   std::shared_ptr<HiCR::LocalMemorySlot>    sourceLocalMemorySlot = nullptr)
    : HiCR::GlobalMemorySlot(globalTag, globalKey, std::move(sourceLocalMemorySlot)),
      _rank(rank)
  {}
 
  ~GlobalMemorySlot() override = default;
 
  __INLINE__ const int getRank() { return _rank; }
 
  __INLINE__ std::unique_ptr<MPI_Win> &getDataWindow() { return _dataWindow; }
 
  __INLINE__ std::unique_ptr<MPI_Win> &getRecvMessageCountWindow() { return _recvMessageCountWindow; }
 
  __INLINE__ std::unique_ptr<MPI_Win> &getSentMessageCountWindow() { return _sentMessageCountWindow; }
 
  [[nodiscard]] __INLINE__ bool getLockAcquiredValue() const { return _lockAcquired; }
 
  __INLINE__ void setLockAcquiredValue(const bool value) { _lockAcquired = value; }
 
  private:
 
  bool _lockAcquired = false;
 
  int _rank;
 
  std::unique_ptr<MPI_Win> _dataWindow = nullptr;
 
  std::unique_ptr<MPI_Win> _recvMessageCountWindow = nullptr;
 
  std::unique_ptr<MPI_Win> _sentMessageCountWindow = nullptr;
};
 
} // namespace HiCR::backend::mpi