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.
 */
 
/*
 * Copyright Huawei Technologies Switzerland AG
 * All rights reserved.
 */
 
#pragma once
 
#include <map>
#include <memory>
#include <hicr/core/localMemorySlot.hpp>
#include <hicr/core/globalMemorySlot.hpp>
#include <hicr/core/memorySpace.hpp>
#include <hicr/core/definitions.hpp>
#include <hicr/core/exceptions.hpp>
 
namespace HiCR
{
 
class MemoryManager
{
  public:
 
  virtual ~MemoryManager() = default;
 
  __INLINE__ std::shared_ptr<LocalMemorySlot> allocateLocalMemorySlot(const std::shared_ptr<MemorySpace> &memorySpace, const size_t size)
  {
    // Creating new memory slot structure
    auto newMemSlot = allocateLocalMemorySlotImpl(memorySpace, size);
 
    // Returning the id of the new memory slot
    return newMemSlot;
  }
 
  virtual std::shared_ptr<LocalMemorySlot> registerLocalMemorySlot(const std::shared_ptr<HiCR::MemorySpace> &memorySpace, void *const ptr, const size_t size)
  {
    // Creating new memory slot structure
    auto newMemSlot = registerLocalMemorySlotImpl(memorySpace, ptr, size);
 
    // Returning the id of the new memory slot
    return newMemSlot;
  }
 
  __INLINE__ void deregisterLocalMemorySlot(const std::shared_ptr<HiCR::LocalMemorySlot> &memorySlot)
  {
    // Calling internal implementation
    deregisterLocalMemorySlotImpl(memorySlot);
  }
 
  __INLINE__ void memset(const std::shared_ptr<HiCR::LocalMemorySlot> &memorySlot, int value, size_t size)
  {
    // Checking whether the pointer is valid
    if (memorySlot->getPointer() == nullptr) HICR_THROW_RUNTIME("Invalid memory slot provided. It either does not exist or represents a NULL pointer.");
 
    memsetImpl(memorySlot, value, size);
  }
 
  __INLINE__ void freeLocalMemorySlot(const std::shared_ptr<HiCR::LocalMemorySlot> &memorySlot)
  {
    // Actually freeing up slot
    freeLocalMemorySlotImpl(memorySlot);
  }
 
  protected:
 
  virtual std::shared_ptr<HiCR::LocalMemorySlot> allocateLocalMemorySlotImpl(std::shared_ptr<HiCR::MemorySpace> memorySpace, const size_t size) = 0;
 
  virtual std::shared_ptr<LocalMemorySlot> registerLocalMemorySlotImpl(std::shared_ptr<HiCR::MemorySpace> memorySpace, void *const ptr, const size_t size) = 0;
 
  virtual void memsetImpl(const std::shared_ptr<HiCR::LocalMemorySlot> memorySlot, int value, size_t size)
  {
    // Default implementation: using standard memset. Almost all backends can use this so no reason to reimplement it everywhere.
    std::memset(memorySlot->getPointer(), value, size);
  }
 
  virtual void freeLocalMemorySlotImpl(std::shared_ptr<HiCR::LocalMemorySlot> memorySlot) = 0;
 
  virtual void deregisterLocalMemorySlotImpl(std::shared_ptr<HiCR::LocalMemorySlot> memorySlot) = 0;
};
 
} // namespace HiCR