Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2023.
[simgrid.git] / src / kernel / routing / DragonflyZone.cpp
index bc7a8c1..e8e4b9a 100644 (file)
@@ -1,26 +1,25 @@
-/* Copyright (c) 2014-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2014-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "simgrid/kernel/routing/DragonflyZone.hpp"
 #include "simgrid/kernel/routing/NetPoint.hpp"
-#include "src/surf/network_interface.hpp"
+#include "src/kernel/resource/NetworkModel.hpp"
 
 #include <boost/algorithm/string/classification.hpp>
 #include <boost/algorithm/string/split.hpp>
 #include <numeric>
 #include <string>
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_dragonfly, surf_route_cluster, "Dragonfly Routing part of surf");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_routing_dragonfly, ker_routing, "Kernel Dragonfly Routing");
 
 namespace simgrid {
-namespace kernel {
-namespace routing {
+namespace kernel::routing {
 
-DragonflyZone::DragonflyZone(const std::string& name) : ClusterZone(name) {}
+DragonflyZone::DragonflyZone(const std::string& name) : ClusterBase(name) {}
 
-DragonflyZone::Coords DragonflyZone::rankId_to_coords(int rankId) const
+DragonflyZone::Coords DragonflyZone::rankId_to_coords(unsigned long rankId) const
 {
   // coords : group, chassis, blade, node
   Coords coords;
@@ -33,18 +32,9 @@ DragonflyZone::Coords DragonflyZone::rankId_to_coords(int rankId) const
   return coords;
 }
 
-void DragonflyZone::rankId_to_coords(int rankId, unsigned int coords[4]) const // XBT_ATTRIB_DEPRECATED_v330
-{
-  const auto s_coords = rankId_to_coords(rankId);
-  coords[0]           = s_coords.group;
-  coords[1]           = s_coords.chassis;
-  coords[2]           = s_coords.blade;
-  coords[3]           = s_coords.node;
-}
-
 void DragonflyZone::set_link_characteristics(double bw, double lat, s4u::Link::SharingPolicy sharing_policy)
 {
-  ClusterZone::set_link_characteristics(bw, lat, sharing_policy);
+  ClusterBase::set_link_characteristics(bw, lat, sharing_policy);
   if (sharing_policy == s4u::Link::SharingPolicy::SPLITDUPLEX)
     num_links_per_link_ = 2;
 }
@@ -83,14 +73,14 @@ s4u::DragonflyParams DragonflyZone::parse_topo_parameters(const std::string& top
   try {
     n_groups = std::stoi(tmp[0]);
   } catch (const std::invalid_argument&) {
-    throw std::invalid_argument(std::string("Invalid number of groups:") + tmp[0]);
+    throw std::invalid_argument("Invalid number of groups:" + tmp[0]);
   }
 
   unsigned int n_blue;
   try {
     n_blue = std::stoi(tmp[1]);
   } catch (const std::invalid_argument&) {
-    throw std::invalid_argument(std::string("Invalid number of links for the blue level:") + tmp[1]);
+    throw std::invalid_argument("Invalid number of links for the blue level:" + tmp[1]);
   }
 
   // Black network : number of chassis/group, number of links between each router on the black network
@@ -102,14 +92,14 @@ s4u::DragonflyParams DragonflyZone::parse_topo_parameters(const std::string& top
   try {
     n_chassis = std::stoi(tmp[0]);
   } catch (const std::invalid_argument&) {
-    throw std::invalid_argument(std::string("Invalid number of chassis:") + tmp[0]);
+    throw std::invalid_argument("Invalid number of chassis:" + tmp[0]);
   }
 
   unsigned int n_black;
   try {
     n_black = std::stoi(tmp[1]);
   } catch (const std::invalid_argument&) {
-    throw std::invalid_argument(std::string("Invalid number of links for the black level:") + tmp[1]);
+    throw std::invalid_argument("Invalid number of links for the black level:" + tmp[1]);
   }
 
   // Green network : number of blades/chassis, number of links between each router on the green network
@@ -121,14 +111,14 @@ s4u::DragonflyParams DragonflyZone::parse_topo_parameters(const std::string& top
   try {
     n_routers = std::stoi(tmp[0]);
   } catch (const std::invalid_argument&) {
-    throw std::invalid_argument(std::string("Invalid number of routers:") + tmp[0]);
+    throw std::invalid_argument("Invalid number of routers:" + tmp[0]);
   }
 
   unsigned int n_green;
   try {
     n_green = std::stoi(tmp[1]);
   } catch (const std::invalid_argument&) {
-    throw std::invalid_argument(std::string("Invalid number of links for the green level:") + tmp[1]);
+    throw std::invalid_argument("Invalid number of links for the green level:" + tmp[1]);
   }
 
   // The last part of topo_parameters should be the number of nodes per blade
@@ -136,50 +126,61 @@ s4u::DragonflyParams DragonflyZone::parse_topo_parameters(const std::string& top
   try {
     n_nodes = std::stoi(parameters[3]);
   } catch (const std::invalid_argument&) {
-    throw std::invalid_argument(std::string("Last parameter is not the amount of nodes per blade:") + parameters[3]);
+    throw std::invalid_argument("Last parameter is not the amount of nodes per blade:" + parameters[3]);
   }
   return s4u::DragonflyParams({n_groups, n_blue}, {n_chassis, n_black}, {n_routers, n_green}, n_nodes);
 }
 
 /* Generate the cluster once every node is created */
-void DragonflyZone::do_seal()
+void DragonflyZone::build_upper_levels(const s4u::ClusterCallbacks& set_callbacks)
 {
-  if (num_nodes_per_blade_ == 0)
-    return;
-
-  generate_routers();
+  generate_routers(set_callbacks);
   generate_links();
 }
 
-void DragonflyZone::generate_routers()
+void DragonflyZone::generate_routers(const s4u::ClusterCallbacks& set_callbacks)
 {
-  routers_.reserve(num_groups_ * num_chassis_per_group_ * num_blades_per_chassis_);
-  for (unsigned int i = 0; i < num_groups_; i++)
-    for (unsigned int j = 0; j < num_chassis_per_group_; j++)
-      for (unsigned int k = 0; k < num_blades_per_chassis_; k++)
-        routers_.emplace_back(i, j, k);
+  unsigned long id = 2UL * num_groups_ * num_chassis_per_group_ * num_blades_per_chassis_ * num_nodes_per_blade_;
+  /* get limiter for this router */
+  auto get_limiter = [this, &id, &set_callbacks](unsigned int i, unsigned int j,
+                                                 unsigned int k) -> resource::StandardLinkImpl* {
+    kernel::resource::StandardLinkImpl* limiter = nullptr;
+    if (set_callbacks.limiter) {
+      id--;
+      const auto* s4u_link =
+          set_callbacks.limiter(get_iface(), {i, j, k, std::numeric_limits<unsigned int>::max()}, id);
+      if (s4u_link) {
+        limiter = s4u_link->get_impl();
+      }
+    }
+    return limiter;
+  };
+
+  routers_.reserve(static_cast<size_t>(num_groups_) * num_chassis_per_group_ * num_blades_per_chassis_);
+  for (unsigned int i = 0; i < num_groups_; i++) {
+    for (unsigned int j = 0; j < num_chassis_per_group_; j++) {
+      for (unsigned int k = 0; k < num_blades_per_chassis_; k++) {
+        routers_.emplace_back(i, j, k, get_limiter(i, j, k));
+      }
+    }
+  }
 }
 
-void DragonflyZone::generate_link(const std::string& id, int numlinks, resource::LinkImpl** linkup,
-                                  resource::LinkImpl** linkdown)
+void DragonflyZone::generate_link(const std::string& id, int numlinks, resource::StandardLinkImpl** linkup,
+                                  resource::StandardLinkImpl** linkdown)
 {
   XBT_DEBUG("Generating link %s", id.c_str());
   *linkup   = nullptr;
   *linkdown = nullptr;
   if (get_link_sharing_policy() == s4u::Link::SharingPolicy::SPLITDUPLEX) {
-    *linkup = create_link(id + "_UP", std::vector<double>{get_link_bandwidth() * numlinks})
-                  ->set_latency(get_link_latency())
-                  ->seal()
-                  ->get_impl();
-    *linkdown = create_link(id + "_DOWN", std::vector<double>{get_link_bandwidth() * numlinks})
+    *linkup =
+        create_link(id + "_UP", {get_link_bandwidth() * numlinks})->set_latency(get_link_latency())->seal()->get_impl();
+    *linkdown = create_link(id + "_DOWN", {get_link_bandwidth() * numlinks})
                     ->set_latency(get_link_latency())
                     ->seal()
                     ->get_impl();
   } else {
-    *linkup = create_link(id, std::vector<double>{get_link_bandwidth() * numlinks})
-                  ->set_latency(get_link_latency())
-                  ->seal()
-                  ->get_impl();
+    *linkup   = create_link(id, {get_link_bandwidth() * numlinks})->set_latency(get_link_latency())->seal()->get_impl();
     *linkdown = *linkup;
   }
 }
@@ -187,15 +188,15 @@ void DragonflyZone::generate_link(const std::string& id, int numlinks, resource:
 void DragonflyZone::generate_links()
 {
   static int uniqueId = 0;
-  resource::LinkImpl* linkup;
-  resource::LinkImpl* linkdown;
+  resource::StandardLinkImpl* linkup;
+  resource::StandardLinkImpl* linkdown;
 
   unsigned int numRouters = num_groups_ * num_chassis_per_group_ * num_blades_per_chassis_;
 
   // Links from routers to their local nodes.
   for (unsigned int i = 0; i < numRouters; i++) {
     // allocate structures
-    routers_[i].my_nodes_.resize(num_links_per_link_ * num_nodes_per_blade_);
+    routers_[i].my_nodes_.resize(static_cast<size_t>(num_links_per_link_) * num_nodes_per_blade_);
     routers_[i].green_links_.resize(num_blades_per_chassis_);
     routers_[i].black_links_.resize(num_chassis_per_group_);
 
@@ -265,7 +266,7 @@ void DragonflyZone::generate_links()
   }
 }
 
-void DragonflyZone::get_local_route(NetPoint* src, NetPoint* dst, Route* route, double* latency)
+void DragonflyZone::get_local_route(const NetPoint* src, const NetPoint* dst, Route* route, double* latency)
 {
   // Minimal routing version.
   // TODO : non-minimal random one, and adaptive ?
@@ -273,23 +274,21 @@ void DragonflyZone::get_local_route(NetPoint* src, NetPoint* dst, Route* route,
   if (dst->is_router() || src->is_router())
     return;
 
-  XBT_VERB("dragonfly getLocalRoute from '%s'[%u] to '%s'[%u]", src->get_cname(), src->id(), dst->get_cname(),
+  XBT_VERB("dragonfly getLocalRoute from '%s'[%lu] to '%s'[%lu]", src->get_cname(), src->id(), dst->get_cname(),
            dst->id());
 
   if ((src->id() == dst->id()) && has_loopback()) {
-    resource::LinkImpl* uplink = get_uplink_from(node_pos(src->id()));
+    resource::StandardLinkImpl* uplink = get_uplink_from(node_pos(src->id()));
 
-    route->link_list_.push_back(uplink);
-    if (latency)
-      *latency += uplink->get_latency();
+    add_link_latency(route->link_list_, uplink, latency);
     return;
   }
 
   const auto myCoords     = rankId_to_coords(src->id());
   const auto targetCoords = rankId_to_coords(dst->id());
-  XBT_DEBUG("src : %u group, %u chassis, %u blade, %u node", myCoords.group, myCoords.chassis, myCoords.blade,
+  XBT_DEBUG("src : %lu group, %lu chassis, %lu blade, %lu node", myCoords.group, myCoords.chassis, myCoords.blade,
             myCoords.node);
-  XBT_DEBUG("dst : %u group, %u chassis, %u blade, %u node", targetCoords.group, targetCoords.chassis,
+  XBT_DEBUG("dst : %lu group, %lu chassis, %lu blade, %lu node", targetCoords.group, targetCoords.chassis,
             targetCoords.blade, targetCoords.node);
 
   DragonflyRouter* myRouter      = &routers_[myCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) +
@@ -298,79 +297,75 @@ void DragonflyZone::get_local_route(NetPoint* src, NetPoint* dst, Route* route,
                                             targetCoords.chassis * num_blades_per_chassis_ + targetCoords.blade];
   DragonflyRouter* currentRouter = myRouter;
 
-  // node->router local link
-  route->link_list_.push_back(myRouter->my_nodes_[myCoords.node * num_links_per_link_]);
-  if (latency)
-    *latency += myRouter->my_nodes_[myCoords.node * num_links_per_link_]->get_latency();
-
   if (has_limiter()) { // limiter for sender
     route->link_list_.push_back(get_uplink_from(node_pos_with_loopback(src->id())));
   }
 
+  // node->router local link
+  add_link_latency(route->link_list_, myRouter->my_nodes_[myCoords.node * num_links_per_link_], latency);
+
   if (targetRouter != myRouter) {
     // are we on a different group ?
     if (targetRouter->group_ != currentRouter->group_) {
       // go to the router of our group connected to this one.
       if (currentRouter->blade_ != targetCoords.group) {
+        if (currentRouter->limiter_)
+          route->link_list_.push_back(currentRouter->limiter_);
         // go to the nth router in our chassis
-        route->link_list_.push_back(currentRouter->green_links_[targetCoords.group]);
-        if (latency)
-          *latency += currentRouter->green_links_[targetCoords.group]->get_latency();
+        add_link_latency(route->link_list_, currentRouter->green_links_[targetCoords.group], latency);
         currentRouter = &routers_[myCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) +
                                   myCoords.chassis * num_blades_per_chassis_ + targetCoords.group];
       }
 
       if (currentRouter->chassis_ != 0) {
         // go to the first chassis of our group
-        route->link_list_.push_back(currentRouter->black_links_[0]);
-        if (latency)
-          *latency += currentRouter->black_links_[0]->get_latency();
+        if (currentRouter->limiter_)
+          route->link_list_.push_back(currentRouter->limiter_);
+        add_link_latency(route->link_list_, currentRouter->black_links_[0], latency);
         currentRouter =
             &routers_[myCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) + targetCoords.group];
       }
 
       // go to destination group - the only optical hop
-      route->link_list_.push_back(currentRouter->blue_link_);
-      if (latency)
-        *latency += currentRouter->blue_link_->get_latency();
+      add_link_latency(route->link_list_, currentRouter->blue_link_, latency);
+      if (currentRouter->limiter_)
+        route->link_list_.push_back(currentRouter->limiter_);
       currentRouter =
           &routers_[targetCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) + myCoords.group];
     }
 
     // same group, but same blade ?
     if (targetRouter->blade_ != currentRouter->blade_) {
-      route->link_list_.push_back(currentRouter->green_links_[targetCoords.blade]);
-      if (latency)
-        *latency += currentRouter->green_links_[targetCoords.blade]->get_latency();
+      if (currentRouter->limiter_)
+        route->link_list_.push_back(currentRouter->limiter_);
+      add_link_latency(route->link_list_, currentRouter->green_links_[targetCoords.blade], latency);
       currentRouter =
           &routers_[targetCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) + targetCoords.blade];
     }
 
     // same blade, but same chassis ?
     if (targetRouter->chassis_ != currentRouter->chassis_) {
-      route->link_list_.push_back(currentRouter->black_links_[targetCoords.chassis]);
-      if (latency)
-        *latency += currentRouter->black_links_[targetCoords.chassis]->get_latency();
+      if (currentRouter->limiter_)
+        route->link_list_.push_back(currentRouter->limiter_);
+      add_link_latency(route->link_list_, currentRouter->black_links_[targetCoords.chassis], latency);
     }
   }
 
+  // router->node local link
+  if (targetRouter->limiter_)
+    route->link_list_.push_back(targetRouter->limiter_);
+  add_link_latency(route->link_list_,
+                   targetRouter->my_nodes_[targetCoords.node * num_links_per_link_ + num_links_per_link_ - 1], latency);
+
   if (has_limiter()) { // limiter for receiver
     route->link_list_.push_back(get_downlink_to(node_pos_with_loopback(dst->id())));
   }
 
-  // router->node local link
-  route->link_list_.push_back(
-      targetRouter->my_nodes_[targetCoords.node * num_links_per_link_ + num_links_per_link_ - 1]);
-  if (latency)
-    *latency +=
-        targetRouter->my_nodes_[targetCoords.node * num_links_per_link_ + num_links_per_link_ - 1]->get_latency();
-
   // set gateways (if any)
   route->gw_src_ = get_gateway(src->id());
   route->gw_dst_ = get_gateway(dst->id());
 }
-} // namespace routing
-} // namespace kernel
+} // namespace kernel::routing
 
 namespace s4u {
 DragonflyParams::DragonflyParams(const std::pair<unsigned int, unsigned int>& groups,
@@ -415,8 +410,8 @@ NetZone* create_dragonfly_zone(const std::string& name, const NetZone* parent, c
   zone->set_link_characteristics(bandwidth, latency, sharing_policy);
 
   /* populating it */
-  std::vector<unsigned int> dimensions = {params.groups.first, params.chassis.first, params.routers.first,
-                                          params.nodes};
+  std::vector<unsigned long> dimensions = {params.groups.first, params.chassis.first, params.routers.first,
+                                           params.nodes};
   int tot_elements                     = std::accumulate(dimensions.begin(), dimensions.end(), 1, std::multiplies<>());
   for (int i = 0; i < tot_elements; i++) {
     kernel::routing::NetPoint* netpoint;
@@ -424,7 +419,7 @@ NetZone* create_dragonfly_zone(const std::string& name, const NetZone* parent, c
     Link* loopback;
     zone->fill_leaf_from_cb(i, dimensions, set_callbacks, &netpoint, &loopback, &limiter);
   }
-
+  zone->build_upper_levels(set_callbacks);
   return zone->get_iface();
 }
 } // namespace s4u