memoryManager.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/definitions.hpp>
#include <hicr/core/memoryManager.hpp>
#include <hicr/backends/hwloc/memorySpace.hpp>
#include "localMemorySlot.hpp"
 
namespace HiCR::backend::mpi
{
 
class MemoryManager final : public HiCR::MemoryManager
{
  public:
 
  MemoryManager()
    : HiCR::MemoryManager()
  {}
  ~MemoryManager() override = default;
 
  __INLINE__ std::shared_ptr<HiCR::LocalMemorySlot> allocateLocalMemorySlotImpl(std::shared_ptr<HiCR::MemorySpace> memorySpace, const size_t size) override
  {
    // Getting up-casted pointer for the MPI instance
    auto m = dynamic_pointer_cast<hwloc::MemorySpace>(memorySpace);
 
    // Checking whether the execution unit passed is compatible with this backend
    if (m == nullptr) HICR_THROW_LOGIC("The passed memory space is not supported by this memory manager\n");
 
    // Storage for the new pointer
    void *ptr = nullptr;
 
    // Attempting to allocate the new memory slot
    auto status = MPI_Alloc_mem((MPI_Aint)size, MPI_INFO_NULL, &ptr);
 
    // Check whether it was successful
    if (status != MPI_SUCCESS || ptr == nullptr) HICR_THROW_RUNTIME("Could not allocate memory of size %lu", size);
 
    // Creating and returning new memory slot
    return registerLocalMemorySlotImpl(memorySpace, ptr, size);
  }
 
  __INLINE__ void freeLocalMemorySlotImpl(std::shared_ptr<HiCR::LocalMemorySlot> memorySlot) override {}
 
  __INLINE__ std::shared_ptr<HiCR::LocalMemorySlot> registerLocalMemorySlotImpl(std::shared_ptr<HiCR::MemorySpace> memorySpace, void *const ptr, const size_t size) override
  {
    // Creating new memory slot object
    auto memorySlot = std::make_shared<HiCR::backend::mpi::LocalMemorySlot>(ptr, size, memorySpace);
 
    // Returning new memory slot pointer
    return memorySlot;
  }
 
  __INLINE__ void deregisterLocalMemorySlotImpl(std::shared_ptr<HiCR::LocalMemorySlot> memorySlot) override
  {
    // Nothing to do here for this backend
  }
};
 
} // namespace HiCR::backend::mpi