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 <nlohmann_json/parser.hpp>
#include <hicr/core/device.hpp>
 
namespace HiCR
{
 
class Topology
{
  public:
 
  using deviceList_t = std::vector<std::shared_ptr<Device>>;
 
  Topology()  = default;
  ~Topology() = default;
 
  Topology(const nlohmann::json &input) { deserialize(input); }
 
  [[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__ void deserialize(const nlohmann::json &input)
  {
    if (input.contains("Devices"))
    {
      const auto &devicesJs = hicr::json::getArray<nlohmann::json>(input, "Devices");
      for (const auto &deviceJs : devicesJs) addDevice(std::make_shared<Device>(deviceJs));
    }
 
    if (input.contains("Metadata")) _metadata = hicr::json::getObject(input, "Metadata");
  };
 
  __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");
    }
  };
 
  [[nodiscard]] __INLINE__ bool isSubset(const HiCR::Topology givenTopology)
  {
    // Making a copy of the current topology.
    // Devices will be removed as we match them with the given device
    auto currentDevices = getDevices();
 
    const auto givenDevices = givenTopology.getDevices();
 
    for (const auto &givenDevice : givenDevices)
    {
      const auto givenDeviceType             = givenDevice->getType();
      const auto givenDeviceMemorySpaces     = givenDevice->getMemorySpaceList();
      const auto givenDeviceComputeResources = givenDevice->getComputeResourceList();
 
      // Iterating over all the current devices to see if one of them satisfies this given device
      bool foundCompatibleDevice = false;
      for (auto currentDeviceItr = currentDevices.begin(); currentDeviceItr != currentDevices.end() && foundCompatibleDevice == false; currentDeviceItr++)
      {
        // Getting current device object
        const auto &currentDevice = currentDeviceItr.operator*();
 
        // Checking type
        const auto &currentDeviceType = currentDevice->getType();
 
        // If this device is the same type as given, proceed to check compute resources and memory spaces
        if (currentDeviceType == givenDeviceType)
        {
          // Flag to indicate this device is compatible with the request
          bool deviceIsCompatible = true;
 
          auto currentComputeResources = currentDevice->getComputeResourceList();
 
          // Getting compute resources in this current device
          for (const auto &givenComputeResource : givenDeviceComputeResources)
          {
            bool foundComputeResource = false;
            for (auto currentComputeResourceItr = currentComputeResources.begin(); currentComputeResourceItr != currentComputeResources.end() && foundComputeResource == false;
                 currentComputeResourceItr++)
            {
              // Getting current device object
              const auto &currentComputeResource = currentComputeResourceItr.operator*();
 
              // If it's the same type as given
              if (currentComputeResource->getType() == givenComputeResource->getType())
              {
                // Set compute resource as found
                foundComputeResource = true;
 
                // Erase this element from the list to not re-use it
                currentComputeResources.erase(currentComputeResourceItr);
              }
            }
 
            // If no compute resource was found, abandon search in this device
            if (foundComputeResource == false)
            {
              deviceIsCompatible = false;
              break;
            }
          }
 
          // If no suitable device was found, advance with the next one
          if (deviceIsCompatible == false) continue;
 
          auto currentMemorySpaces = currentDevice->getMemorySpaceList();
 
          // Getting compute resources in this current device
          for (const auto &givenDeviceMemorySpace : givenDeviceMemorySpaces)
          {
            bool foundMemorySpace = false;
            for (auto currentMemorySpaceItr = currentMemorySpaces.begin(); currentMemorySpaceItr != currentMemorySpaces.end() && foundMemorySpace == false; currentMemorySpaceItr++)
            {
              // Getting current device object
              const auto &currentDeviceMemorySpace = currentMemorySpaceItr.operator*();
 
              // If it's the same type as given
              if (currentDeviceMemorySpace->getType() == givenDeviceMemorySpace->getType())
              {
                // Check whether the size is at least as big as given
                if (currentDeviceMemorySpace->getSize() >= givenDeviceMemorySpace->getSize())
                {
                  // Set compute resource as found
                  foundMemorySpace = true;
 
                  // Erase this element from the list to not re-use it
                  currentMemorySpaces.erase(currentMemorySpaceItr);
                }
              }
            }
 
            // If no compute resource was found, abandon search in this device
            if (foundMemorySpace == false)
            {
              deviceIsCompatible = false;
              break;
            }
          }
 
          // If no suitable device was found, advance with the next one
          if (deviceIsCompatible == false) continue;
 
          // If we reached this point, we've found the device
          foundCompatibleDevice = true;
 
          // Deleting device to prevent it from being counted again
          currentDevices.erase(currentDeviceItr);
 
          // Stop checking
          break;
        }
      }
 
      // If no current devices could satisfy the given device, return false now
      if (foundCompatibleDevice == false) return false;
    }
 
    // All requirements have been met, returning true
    //printf("Requirements met\n");
    return true;
  }
 
  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