memorySpace.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 <nlohmann_json/json.hpp>
#include <hicr/core/definitions.hpp>
#include <hicr/core/memorySpace.hpp>
#include <hicr/backends/opencl/localMemorySlot.hpp>
 
namespace HiCR::backend::opencl
{
 
class Device;
 
class MemorySpace final : public HiCR::MemorySpace
{
  public:
 
  MemorySpace(const std::weak_ptr<opencl::Device> device, const size_t size)
    : HiCR::MemorySpace(size),
      _device(device)
  {
    _type = "OpenCL Device RAM";
  };
 
  MemorySpace()
    : HiCR::MemorySpace()
  {
    _type = "OpenCL Device RAM";
  }
 
  ~MemorySpace() = default;
 
  MemorySpace(const nlohmann::json &input)
    : HiCR::MemorySpace()
  {
    deserialize(input);
  }
 
  __INLINE__ const std::weak_ptr<const opencl::Device> getDevice() const { return _device; }
 
  private:
 
  __INLINE__ void serializeImpl(nlohmann::json &output) const override { output["Memory Space Type"] = _type; }
 
  __INLINE__ void deserializeImpl(const nlohmann::json &input) override
  {
    std::string typeKey = "Memory Space Type";
    if (input.contains(typeKey) == false) HICR_THROW_LOGIC("The serialized object contains no '%s' key", typeKey.c_str());
    if (input[typeKey].is_number() == false) HICR_THROW_LOGIC("The '%s' entry is not a number", typeKey.c_str());
    _type = input[typeKey].get<std::string>();
  }
 
  std::weak_ptr<opencl::Device> _device;
 
  std::string _type;
};
 
} // namespace HiCR::backend::opencl