Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move the surf log categories elsewhere
[simgrid.git] / src / kernel / routing / FatTreeZone.cpp
index 2aa3799..0c33475 100644 (file)
@@ -1,36 +1,28 @@
-/* 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/FatTreeZone.hpp>
+#include <simgrid/kernel/routing/NetPoint.hpp>
+
+#include "src/kernel/resource/NetworkModel.hpp"
+#include "src/surf/xml/platf.hpp" // surf_parse_error() and surf_parse_assert()
+
 #include <fstream>
 #include <numeric>
 #include <sstream>
 #include <string>
 
-#include "simgrid/kernel/routing/FatTreeZone.hpp"
-#include "simgrid/kernel/routing/NetPoint.hpp"
-#include "src/surf/network_interface.hpp"
-#include "src/surf/xml/platf_private.hpp"
-
 #include <boost/algorithm/string/classification.hpp>
 #include <boost/algorithm/string/split.hpp>
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_fat_tree, surf, "Routing for fat trees");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_routing_fat_tree, ker_platform, "Kernel Fat-Tree Routing");
 
 namespace simgrid {
-namespace kernel {
-namespace routing {
+namespace kernel::routing {
 
-FatTreeZone::~FatTreeZone()
-{
-  for (FatTreeNode const* node : this->nodes_)
-    delete node;
-  for (FatTreeLink const* link : this->links_)
-    delete link;
-}
-
-bool FatTreeZone::is_in_sub_tree(FatTreeNode* root, FatTreeNode* node) const
+bool FatTreeZone::is_in_sub_tree(const FatTreeNode* root, const FatTreeNode* node) const
 {
   XBT_DEBUG("Is %d(%u,%u) in the sub tree of %d(%u,%u) ?", node->id, node->level, node->position, root->id, root->level,
             root->position);
@@ -51,34 +43,32 @@ bool FatTreeZone::is_in_sub_tree(FatTreeNode* root, FatTreeNode* node) const
   return true;
 }
 
-void FatTreeZone::get_local_route(NetPoint* src, NetPoint* dst, Route* into, double* latency)
+void FatTreeZone::get_local_route(const NetPoint* src, const NetPoint* dst, Route* into, double* latency)
 {
   if (dst->is_router() || src->is_router())
     return;
 
   /* Let's find the source and the destination in our internal structure */
   auto searchedNode = this->compute_nodes_.find(src->id());
-  xbt_assert(searchedNode != this->compute_nodes_.end(), "Could not find the source %s [%u] in the fat tree",
+  xbt_assert(searchedNode != this->compute_nodes_.end(), "Could not find the source %s [%lu] in the fat tree",
              src->get_cname(), src->id());
-  FatTreeNode* source = searchedNode->second;
+  const FatTreeNode* source = searchedNode->second.get();
 
   searchedNode = this->compute_nodes_.find(dst->id());
-  xbt_assert(searchedNode != this->compute_nodes_.end(), "Could not find the destination %s [%u] in the fat tree",
+  xbt_assert(searchedNode != this->compute_nodes_.end(), "Could not find the destination %s [%lu] in the fat tree",
              dst->get_cname(), dst->id());
-  FatTreeNode* destination = searchedNode->second;
+  const FatTreeNode* destination = searchedNode->second.get();
 
-  XBT_VERB("Get route and latency from '%s' [%u] to '%s' [%u] in a fat tree", src->get_cname(), src->id(),
+  XBT_VERB("Get route and latency from '%s' [%lu] to '%s' [%lu] in a fat tree", src->get_cname(), src->id(),
            dst->get_cname(), dst->id());
 
   /* In case destination is the source, and there is a loopback, let's use it instead of going up to a switch */
   if (source->id == destination->id && has_loopback()) {
-    into->link_list_.push_back(source->loopback_);
-    if (latency)
-      *latency += source->loopback_->get_latency();
+    add_link_latency(into->link_list_, source->loopback_, latency);
     return;
   }
 
-  FatTreeNode* currentNode = source;
+  const FatTreeNode* currentNode = source;
 
   // up part
   while (not is_in_sub_tree(currentNode, destination)) {
@@ -87,16 +77,13 @@ void FatTreeZone::get_local_route(NetPoint* src, NetPoint* dst, Route* into, dou
     for (unsigned int i = 0; i < currentNode->level; i++)
       d /= this->num_parents_per_node_[i];
 
-    int k = this->num_parents_per_node_[currentNode->level];
-    d     = d % k;
+    int k = this->num_parents_per_node_[currentNode->level] * this->num_port_lower_level_[currentNode->level];
+    d = d % k;
 
     if (currentNode->limiter_link_)
       into->link_list_.push_back(currentNode->limiter_link_);
 
-    into->link_list_.push_back(currentNode->parents[d]->up_link_);
-
-    if (latency)
-      *latency += currentNode->parents[d]->up_link_->get_latency();
+    add_link_latency(into->link_list_, currentNode->parents[d]->up_link_, latency);
 
     currentNode = currentNode->parents[d]->up_node_;
   }
@@ -106,16 +93,15 @@ void FatTreeZone::get_local_route(NetPoint* src, NetPoint* dst, Route* into, dou
 
   // Down part
   while (currentNode != destination) {
-    for (unsigned int i = 0; i < currentNode->children.size(); i++) {
+    //pick cable when multiple parallels
+    int d = source->position % this->num_port_lower_level_[currentNode->level - 1];
+    for (unsigned int i = d * this->num_children_per_node_[currentNode->level - 1]; i < currentNode->children.size(); i++) {
       if (i % this->num_children_per_node_[currentNode->level - 1] == destination->label[currentNode->level - 1]) {
-
-        into->link_list_.push_back(currentNode->children[i]->down_link_);
+        add_link_latency(into->link_list_, currentNode->children[i]->down_link_, latency);
 
         if (currentNode->limiter_link_)
           into->link_list_.push_back(currentNode->limiter_link_);
 
-        if (latency)
-          *latency += currentNode->children[i]->down_link_->get_latency();
         currentNode = currentNode->children[i]->down_node_;
         XBT_DEBUG("%d(%u,%u) is accessible through %d(%u,%u)", destination->id, destination->level,
                   destination->position, currentNode->id, currentNode->level, currentNode->position);
@@ -139,7 +125,7 @@ void FatTreeZone::build_upper_levels(const s4u::ClusterCallbacks& set_callbacks)
   // Nodes are totally ordered, by level and then by position, in this->nodes
   for (unsigned int i = 0; i < levels_; i++) {
     for (unsigned int j = 0; j < nodes_by_level_[i]; j++) {
-      connect_node_to_parents(nodes_[k]);
+      connect_node_to_parents(nodes_[k].get());
       k++;
     }
   }
@@ -150,7 +136,7 @@ void FatTreeZone::do_seal()
   if (this->levels_ == 0) {
     return;
   }
-  if (not XBT_LOG_ISENABLED(surf_route_fat_tree, xbt_log_priority_debug)) {
+  if (not XBT_LOG_ISENABLED(ker_routing_fat_tree, xbt_log_priority_debug)) {
     return;
   }
 
@@ -166,14 +152,14 @@ void FatTreeZone::do_seal()
   msgBuffer.str("");
   msgBuffer << "Nodes are : ";
 
-  for (FatTreeNode const* node : this->nodes_) {
+  for (auto const& node : this->nodes_) {
     msgBuffer << node->id << "(" << node->level << "," << node->position << ") ";
   }
   XBT_DEBUG("%s", msgBuffer.str().c_str());
 
   msgBuffer.clear();
   msgBuffer << "Links are : ";
-  for (FatTreeLink const* link : this->links_) {
+  for (auto const& link : this->links_) {
     msgBuffer << "(" << link->up_node_->id << "," << link->down_node_->id << ") ";
   }
   XBT_DEBUG("%s", msgBuffer.str().c_str());
@@ -187,13 +173,13 @@ int FatTreeZone::connect_node_to_parents(FatTreeNode* node)
   XBT_DEBUG("We are connecting node %d(%u,%u) to his parents.", node->id, node->level, node->position);
   currentParentNode += this->get_level_position(level + 1);
   for (unsigned int i = 0; i < this->nodes_by_level_[level + 1]; i++) {
-    if (this->are_related(*currentParentNode, node)) {
+    if (this->are_related(currentParentNode->get(), node)) {
       XBT_DEBUG("%d(%u,%u) and %d(%u,%u) are related,"
                 " with %u links between them.",
                 node->id, node->level, node->position, (*currentParentNode)->id, (*currentParentNode)->level,
                 (*currentParentNode)->position, this->num_port_lower_level_[level]);
       for (unsigned int j = 0; j < this->num_port_lower_level_[level]; j++) {
-        this->add_link(*currentParentNode, node->label[level] + j * this->num_children_per_node_[level], node,
+        this->add_link(currentParentNode->get(), node->label[level] + j * this->num_children_per_node_[level], node,
                        (*currentParentNode)->label[level] + j * this->num_parents_per_node_[level]);
       }
       connectionsNumber++;
@@ -207,7 +193,7 @@ bool FatTreeZone::are_related(FatTreeNode* parent, FatTreeNode* child) const
 {
   std::stringstream msgBuffer;
 
-  if (XBT_LOG_ISENABLED(surf_route_fat_tree, xbt_log_priority_debug)) {
+  if (XBT_LOG_ISENABLED(ker_routing_fat_tree, xbt_log_priority_debug)) {
     msgBuffer << "Are " << child->id << "(" << child->level << "," << child->position << ") <";
 
     for (unsigned int i = 0; i < this->levels_; i++) {
@@ -246,9 +232,9 @@ void FatTreeZone::generate_switches(const s4u::ClusterCallbacks& set_callbacks)
     this->nodes_by_level_[0] *= this->num_children_per_node_[i];
 
   if (this->nodes_by_level_[0] != this->nodes_.size()) {
-    surf_parse_error(std::string("The number of provided nodes does not fit with the wanted topology.") +
-                     " Please check your platform description (We need " + std::to_string(this->nodes_by_level_[0]) +
-                     "nodes, we got " + std::to_string(this->nodes_.size()));
+    surf_parse_error("The number of provided nodes does not fit with the wanted topology."
+                     " Please check your platform description (We need " +
+                     std::to_string(this->nodes_by_level_[0]) + "nodes, we got " + std::to_string(this->nodes_.size()));
   }
 
   for (unsigned int i = 0; i < this->levels_; i++) {
@@ -263,25 +249,31 @@ void FatTreeZone::generate_switches(const s4u::ClusterCallbacks& set_callbacks)
     this->nodes_by_level_[i + 1] = nodesInThisLevel;
   }
 
-  // Create the switches
-  int k = 0;
-  for (unsigned int i = 0; i < this->levels_; i++) {
-    for (unsigned int j = 0; j < this->nodes_by_level_[i + 1]; j++) {
-      kernel::resource::LinkImpl* limiter = nullptr;
-      int id                              = --k;
-      if (set_callbacks.limiter) {
-        auto* s4u_link = set_callbacks.limiter(get_iface(), {i + 1, j}, id);
-        if (s4u_link)
-          limiter = s4u_link->get_impl();
+  /* get limiter for this router */
+  auto get_limiter = [this, &set_callbacks](unsigned long i, unsigned long j, long id) -> resource::StandardLinkImpl* {
+    kernel::resource::StandardLinkImpl* limiter = nullptr;
+    if (set_callbacks.limiter) {
+      const auto* s4u_link = set_callbacks.limiter(get_iface(), {i + 1, j}, id);
+      if (s4u_link) {
+        limiter = s4u_link->get_impl();
       }
-      auto* newNode = new FatTreeNode(id, i + 1, j, limiter, nullptr);
+    }
+    return limiter;
+  };
+  // Create the switches
+  unsigned long k = 2 * nodes_.size();
+  for (unsigned long i = 0; i < this->levels_; i++) {
+    for (unsigned long j = 0; j < this->nodes_by_level_[i + 1]; j++) {
+      k--;
+      auto newNode = std::make_shared<FatTreeNode>(k, i + 1, j, get_limiter(i, j, k), nullptr);
       XBT_DEBUG("We create the switch %d(%u,%u)", newNode->id, newNode->level, newNode->position);
-      newNode->children.resize(this->num_children_per_node_[i] * this->num_port_lower_level_[i]);
+      newNode->children.resize(static_cast<size_t>(this->num_children_per_node_[i]) * this->num_port_lower_level_[i]);
       if (i != this->levels_ - 1) {
-        newNode->parents.resize(this->num_parents_per_node_[i + 1] * this->num_port_lower_level_[i + 1]);
+        newNode->parents.resize(static_cast<size_t>(this->num_parents_per_node_[i + 1]) *
+                                this->num_port_lower_level_[i + 1]);
       }
       newNode->label.resize(this->levels_);
-      this->nodes_.push_back(newNode);
+      this->nodes_.emplace_back(newNode);
     }
   }
 }
@@ -300,7 +292,7 @@ void FatTreeZone::generate_labels()
     }
 
     for (unsigned int j = 0; j < this->nodes_by_level_[i]; j++) {
-      if (XBT_LOG_ISENABLED(surf_route_fat_tree, xbt_log_priority_debug)) {
+      if (XBT_LOG_ISENABLED(ker_routing_fat_tree, xbt_log_priority_debug)) {
         std::stringstream msgBuffer;
 
         msgBuffer << "Assigning label <";
@@ -342,15 +334,16 @@ int FatTreeZone::get_level_position(const unsigned int level)
   return tempPosition;
 }
 
-void FatTreeZone::add_processing_node(int id, resource::LinkImpl* limiter, resource::LinkImpl* loopback)
+void FatTreeZone::add_processing_node(int id, resource::StandardLinkImpl* limiter, resource::StandardLinkImpl* loopback)
 {
   using std::make_pair;
   static int position = 0;
-  auto* newNode       = new FatTreeNode(id, 0, position++, limiter, loopback);
-  newNode->parents.resize(this->num_parents_per_node_[0] * this->num_port_lower_level_[0]);
+  auto newNode = std::make_shared<FatTreeNode>(id, 0, position, limiter, loopback);
+  position++;
+  newNode->parents.resize(static_cast<size_t>(this->num_parents_per_node_[0]) * this->num_port_lower_level_[0]);
   newNode->label.resize(this->levels_);
-  this->compute_nodes_.insert(make_pair(id, newNode));
-  this->nodes_.push_back(newNode);
+  this->compute_nodes_.try_emplace(id, newNode);
+  this->nodes_.emplace_back(newNode);
 }
 
 void FatTreeZone::add_link(FatTreeNode* parent, unsigned int parentPort, FatTreeNode* child, unsigned int childPort)
@@ -362,23 +355,21 @@ void FatTreeZone::add_link(FatTreeNode* parent, unsigned int parentPort, FatTree
       "link_from_" + std::to_string(child->id) + "_" + std::to_string(parent->id) + "_" + std::to_string(uniqueId);
 
   if (get_link_sharing_policy() == s4u::Link::SharingPolicy::SPLITDUPLEX) {
-    linkup =
-        create_link(id + "_UP", std::vector<double>{get_link_bandwidth()})->set_latency(get_link_latency())->seal();
-    linkdown =
-        create_link(id + "_DOWN", std::vector<double>{get_link_bandwidth()})->set_latency(get_link_latency())->seal();
+    linkup   = create_link(id + "_UP", {get_link_bandwidth()})->set_latency(get_link_latency())->seal();
+    linkdown = create_link(id + "_DOWN", {get_link_bandwidth()})->set_latency(get_link_latency())->seal();
   } else {
-    linkup   = create_link(id, std::vector<double>{get_link_bandwidth()})->set_latency(get_link_latency())->seal();
+    linkup   = create_link(id, {get_link_bandwidth()})->set_latency(get_link_latency())->seal();
     linkdown = linkup;
   }
   uniqueId++;
 
-  auto* newLink = new FatTreeLink(child, parent, linkup->get_impl(), linkdown->get_impl());
+  auto newLink = std::make_shared<FatTreeLink>(child, parent, linkup->get_impl(), linkdown->get_impl());
   XBT_DEBUG("Creating a link between the parent (%u,%u,%u) and the child (%u,%u,%u)", parent->level, parent->position,
             parentPort, child->level, child->position, childPort);
   parent->children[parentPort] = newLink;
   child->parents[childPort]    = newLink;
 
-  this->links_.push_back(newLink);
+  this->links_.emplace_back(newLink);
 }
 
 void FatTreeZone::check_topology(unsigned int n_levels, const std::vector<unsigned int>& down_links,
@@ -432,12 +423,12 @@ s4u::FatTreeParams FatTreeZone::parse_topo_parameters(const std::string& topo_pa
   try {
     n_lev = std::stoi(parameters[0]);
   } catch (const std::invalid_argument&) {
-    surf_parse_error(std::string("First parameter is not the amount of levels: ") + parameters[0]);
+    surf_parse_error("First parameter is not the amount of levels: " + parameters[0]);
   }
 
   // Then, a l-sized vector standing for the children number by level
   boost::split(tmp, parameters[1], boost::is_any_of(","));
-  surf_parse_assert(tmp.size() == n_lev, std::string("You specified ") + std::to_string(n_lev) +
+  surf_parse_assert(tmp.size() == n_lev, "You specified " + std::to_string(n_lev) +
                                              " levels but the child count vector (the first one) contains " +
                                              std::to_string(tmp.size()) + " levels.");
 
@@ -445,33 +436,33 @@ s4u::FatTreeParams FatTreeZone::parse_topo_parameters(const std::string& topo_pa
     try {
       down.push_back(std::stoi(level));
     } catch (const std::invalid_argument&) {
-      surf_parse_error(std::string("Invalid child count: ") + level);
+      surf_parse_error("Invalid child count: " + level);
     }
   }
 
   // Then, a l-sized vector standing for the parents number by level
   boost::split(tmp, parameters[2], boost::is_any_of(","));
-  surf_parse_assert(tmp.size() == n_lev, std::string("You specified ") + std::to_string(n_lev) +
+  surf_parse_assert(tmp.size() == n_lev, "You specified " + std::to_string(n_lev) +
                                              " levels but the parent count vector (the second one) contains " +
                                              std::to_string(tmp.size()) + " levels.");
   for (std::string const& parent : tmp) {
     try {
       up.push_back(std::stoi(parent));
     } catch (const std::invalid_argument&) {
-      surf_parse_error(std::string("Invalid parent count: ") + parent);
+      surf_parse_error("Invalid parent count: " + parent);
     }
   }
 
   // Finally, a l-sized vector standing for the ports number with the lower level
   boost::split(tmp, parameters[3], boost::is_any_of(","));
-  surf_parse_assert(tmp.size() == n_lev, std::string("You specified ") + std::to_string(n_lev) +
+  surf_parse_assert(tmp.size() == n_lev, "You specified " + std::to_string(n_lev) +
                                              " levels but the port count vector (the third one) contains " +
                                              std::to_string(tmp.size()) + " levels.");
   for (std::string const& port : tmp) {
     try {
       count.push_back(std::stoi(port));
     } catch (const std::invalid_argument&) {
-      throw std::invalid_argument(std::string("Invalid lower level port number:") + port);
+      throw std::invalid_argument("Invalid lower level port number:" + port);
     }
   }
   return s4u::FatTreeParams(n_lev, down, up, count);
@@ -484,7 +475,7 @@ void FatTreeZone::generate_dot_file(const std::string& filename) const
   xbt_assert(file.is_open(), "Unable to open file %s", filename.c_str());
 
   file << "graph AsClusterFatTree {\n";
-  for (FatTreeNode const* node : this->nodes_) {
+  for (auto const& node : this->nodes_) {
     file << node->id;
     if (node->id < 0)
       file << " [shape=circle];\n";
@@ -492,14 +483,13 @@ void FatTreeZone::generate_dot_file(const std::string& filename) const
       file << " [shape=hexagon];\n";
   }
 
-  for (FatTreeLink const* link : this->links_) {
+  for (auto const& link : this->links_) {
     file << link->down_node_->id << " -- " << link->up_node_->id << ";\n";
   }
   file << "}";
   file.close();
 }
-} // namespace routing
-} // namespace kernel
+} // namespace kernel::routing
 
 namespace s4u {
 FatTreeParams::FatTreeParams(unsigned int n_levels, const std::vector<unsigned int>& down_links,