device.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 <unordered_set>
#include <nlohmann_json/json.hpp>
#include <hicr/core/computeResource.hpp>
#include <hicr/core/memorySpace.hpp>
#include <utility>
 
constexpr std::string_view _HICR_DEVICE_COMPUTE_RESOURCES_KEY_ = "Compute Resources";
 
constexpr std::string_view _HICR_DEVICE_MEMORY_SPACES_KEY_ = "Memory Spaces";
 
namespace HiCR
{
 
class Device
{
  public:
 
  using computeResourceList_t = std::vector<std::shared_ptr<ComputeResource>>;
 
  using memorySpaceList_t = std::vector<std::shared_ptr<MemorySpace>>;
 
  [[nodiscard]] virtual std::string getType() const = 0;
 
  __INLINE__ const computeResourceList_t &getComputeResourceList() { return _computeResources; }
 
  __INLINE__ const memorySpaceList_t &getMemorySpaceList() { return _memorySpaces; }
 
  __INLINE__ void addComputeResource(const std::shared_ptr<HiCR::ComputeResource> &computeResource) { _computeResources.push_back(computeResource); }
 
  __INLINE__ void addMemorySpace(const std::shared_ptr<HiCR::MemorySpace> &memorySpace) { _memorySpaces.push_back(memorySpace); }
 
  virtual ~Device() = default;
 
  Device(computeResourceList_t computeResources, memorySpaceList_t memorySpaces)
    : _computeResources(std::move(computeResources)),
      _memorySpaces(std::move(memorySpaces)){};
 
  [[nodiscard]] __INLINE__ nlohmann::json serialize() const
  {
    // Storage for newly created serialized output
    nlohmann::json output;
 
    // Getting device type
    output["Type"] = getType();
 
    // Getting device-specific serialization information
    serializeImpl(output);
 
    // Serializing compute resource information
    output[_HICR_DEVICE_COMPUTE_RESOURCES_KEY_] = std::vector<nlohmann::json>();
    for (const auto &computeResource : _computeResources) output[_HICR_DEVICE_COMPUTE_RESOURCES_KEY_] += computeResource->serialize();
 
    // Serializing memory space information
    output[_HICR_DEVICE_MEMORY_SPACES_KEY_] = std::vector<nlohmann::json>();
    for (const auto &memorySpace : _memorySpaces) output[_HICR_DEVICE_MEMORY_SPACES_KEY_] += memorySpace->serialize();
 
    // Returning serialized information
    return output;
  }
 
  __INLINE__ void deserialize(const nlohmann::json &input)
  {
    // First, discard all existing information
    _computeResources.clear();
    _memorySpaces.clear();
 
    // Sanity checks
    if (input.contains(_HICR_DEVICE_COMPUTE_RESOURCES_KEY_) == false)
      HICR_THROW_LOGIC("Serialized device information is invalid, as it lacks the '%s' entry", _HICR_DEVICE_COMPUTE_RESOURCES_KEY_);
    if (input[_HICR_DEVICE_COMPUTE_RESOURCES_KEY_].is_array() == false)
      HICR_THROW_LOGIC("Serialized device information is invalid, as '%s' entry is not an array.", _HICR_DEVICE_COMPUTE_RESOURCES_KEY_);
    for (const auto &c : input[_HICR_DEVICE_COMPUTE_RESOURCES_KEY_])
    {
      if (c.contains("Type") == false) HICR_THROW_LOGIC("In '%s', entry information is invalid, as it lacks the 'Type' entry", _HICR_DEVICE_COMPUTE_RESOURCES_KEY_);
      if (c["Type"].is_string() == false)
        HICR_THROW_LOGIC("In '%s', entry information information is invalid, as the 'Type' entry is not a string", _HICR_DEVICE_COMPUTE_RESOURCES_KEY_);
    }
 
    if (input.contains(_HICR_DEVICE_MEMORY_SPACES_KEY_) == false)
      HICR_THROW_LOGIC("Serialized device information is invalid, as it lacks the '%s' entry", _HICR_DEVICE_MEMORY_SPACES_KEY_);
    if (input[_HICR_DEVICE_MEMORY_SPACES_KEY_].is_array() == false)
      HICR_THROW_LOGIC("Serialized device information is invalid, as '%s' entry is not an array.", _HICR_DEVICE_MEMORY_SPACES_KEY_);
    for (const auto &c : input[_HICR_DEVICE_MEMORY_SPACES_KEY_])
    {
      if (c.contains("Type") == false) HICR_THROW_LOGIC("In '%s', entry information is invalid, as it lacks the 'Type' entry", _HICR_DEVICE_MEMORY_SPACES_KEY_);
      if (c["Type"].is_string() == false)
        HICR_THROW_LOGIC("In '%s', entry information information is invalid, as the 'Type' entry is not a string", _HICR_DEVICE_MEMORY_SPACES_KEY_);
    }
 
    // Then call the backend-specific deserialization function
    deserializeImpl(input);
 
    // Checking whether the deserialization was successful
    if (_computeResources.size() != input[_HICR_DEVICE_COMPUTE_RESOURCES_KEY_].size())
      HICR_THROW_LOGIC("Deserialization failed, as the number of compute resources created (%lu) differs from the ones provided in the serialized input (%lu)",
                       _memorySpaces.size(),
                       input[_HICR_DEVICE_COMPUTE_RESOURCES_KEY_].size());
    if (_memorySpaces.size() != input[_HICR_DEVICE_MEMORY_SPACES_KEY_].size())
      HICR_THROW_LOGIC("Deserialization failed, as the number of memory spaces created (%lu) differs from the ones provided in the serialized input (%lu)",
                       _memorySpaces.size(),
                       input[_HICR_DEVICE_MEMORY_SPACES_KEY_].size());
  };
 
  protected:
 
  Device() = default;
 
  virtual void serializeImpl(nlohmann::json &output) const = 0;
 
  virtual void deserializeImpl(const nlohmann::json &input) = 0;
 
  private:
 
  computeResourceList_t _computeResources;
 
  memorySpaceList_t _memorySpaces;
};
 
} // namespace HiCR