topology.hpp

/*
 *   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/device.hpp>
 
namespace HiCR
{
 
class Topology
{
  public:
 
  using deviceList_t = std::vector<std::shared_ptr<Device>>;
 
  Topology()  = default;
  ~Topology() = default;
 
  [[nodiscard]] __INLINE__ const deviceList_t &getDevices() const { return _deviceList; }
 
  __INLINE__ void addDevice(const std::shared_ptr<HiCR::Device> &device) { _deviceList.push_back(device); }
 
  __INLINE__ void merge(const Topology &source)
  {
    // Adding each device separately
    for (const auto &d : source.getDevices()) addDevice(d);
  }
 
  [[nodiscard]] __INLINE__ nlohmann::json serialize() const
  {
    // Storage for newly created serialized output
    nlohmann::json output;
 
    // Adding serialized devices information into the array
    std::string devicesKey = "Devices";
    output[devicesKey]     = std::vector<nlohmann::json>();
    for (const auto &device : _deviceList) output[devicesKey] += device->serialize();
 
    // Adding metadata, if defined
    output["Metadata"] = _metadata;
 
    // Returning topology
    return output;
  }
 
  __INLINE__ static void verify(const nlohmann::json &input)
  {
    // Sanity checks
    if (input.contains("Devices") == false) HICR_THROW_LOGIC("Serialized topology manager information is invalid, as it lacks the 'Devices' entry");
    if (input["Devices"].is_array() == false) HICR_THROW_LOGIC("Serialized topology manager 'Devices' entry is not an array.");
 
    for (auto device : input["Devices"])
    {
      if (device.contains("Type") == false) HICR_THROW_LOGIC("Serialized device information is invalid, as it lacks the 'Type' entry");
      if (device["Type"].is_string() == false) HICR_THROW_LOGIC("Serialized device information is invalid, as the 'Type' entry is not a string");
    }
  };
 
  nlohmann::json &getMetadata() { return _metadata; }
 
  [[nodiscard]] const nlohmann::json &getMetadata() const { return _metadata; }
 
  void setMetadata(const nlohmann::json &metadata) { _metadata = metadata; }
 
  private:
 
  nlohmann::json _metadata;
 
  deviceList_t _deviceList;
};
 
} // namespace HiCR