Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cleanup in log categories
[simgrid.git] / src / kernel / routing / FatTreeZone.cpp
index a848e8d..2183e2f 100644 (file)
@@ -1,36 +1,29 @@
-/* Copyright (c) 2014-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2014-2022. 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/StandardLinkImpl.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_routing, "Kernel Fat-Tree Routing");
 
 namespace simgrid {
 namespace kernel {
 namespace 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 +44,32 @@ bool FatTreeZone::is_in_sub_tree(FatTreeNode* root, FatTreeNode* node) const
   return true;
 }
 
-void FatTreeZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* 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)) {
@@ -89,13 +80,12 @@ void FatTreeZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArg
 
     int k = this->num_parents_per_node_[currentNode->level];
     d     = d % k;
-    into->link_list.push_back(currentNode->parents[d]->up_link_);
-
-    if (latency)
-      *latency += currentNode->parents[d]->up_link_->get_latency();
 
     if (currentNode->limiter_link_)
-      into->link_list.push_back(currentNode->limiter_link_);
+      into->link_list_.push_back(currentNode->limiter_link_);
+
+    add_link_latency(into->link_list_, currentNode->parents[d]->up_link_, latency);
+
     currentNode = currentNode->parents[d]->up_node_;
   }
 
@@ -106,69 +96,72 @@ void FatTreeZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArg
   while (currentNode != destination) {
     for (unsigned int i = 0; 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_);
-        if (latency)
-          *latency += currentNode->children[i]->down_link_->get_latency();
-        currentNode = currentNode->children[i]->down_node_;
+        add_link_latency(into->link_list_, currentNode->children[i]->down_link_, latency);
+
         if (currentNode->limiter_link_)
-          into->link_list.push_back(currentNode->limiter_link_);
+          into->link_list_.push_back(currentNode->limiter_link_);
+
+        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);
       }
     }
   }
+  if (currentNode->limiter_link_) { // limiter for receiver/destination
+    into->link_list_.push_back(currentNode->limiter_link_);
+  }
   // set gateways (if any)
-  into->gw_src = get_gateway(src->id());
-  into->gw_dst = get_gateway(dst->id());
+  into->gw_src_ = get_gateway(src->id());
+  into->gw_dst_ = get_gateway(dst->id());
+}
+
+void FatTreeZone::build_upper_levels(const s4u::ClusterCallbacks& set_callbacks)
+{
+  generate_switches(set_callbacks);
+  generate_labels();
+
+  unsigned int k = 0;
+  // 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].get());
+      k++;
+    }
+  }
 }
 
-/* This function makes the assumption that parse_specific_arguments() and
- * addNodes() have already been called
- */
 void FatTreeZone::do_seal()
 {
   if (this->levels_ == 0) {
     return;
   }
-  this->generate_switches();
-
-  if (XBT_LOG_ISENABLED(surf_route_fat_tree, xbt_log_priority_debug)) {
-    std::stringstream msgBuffer;
+  if (not XBT_LOG_ISENABLED(ker_routing_fat_tree, xbt_log_priority_debug)) {
+    return;
+  }
 
-    msgBuffer << "We are creating a fat tree of " << this->levels_ << " levels "
-              << "with " << this->nodes_by_level_[0] << " processing nodes";
-    for (unsigned int i = 1; i <= this->levels_; i++) {
-      msgBuffer << ", " << this->nodes_by_level_[i] << " switches at level " << i;
-    }
-    XBT_DEBUG("%s", msgBuffer.str().c_str());
-    msgBuffer.str("");
-    msgBuffer << "Nodes are : ";
+  /* for debugging purpose only, Fat-Tree is already build when seal is called */
+  std::stringstream msgBuffer;
 
-    for (FatTreeNode const* node : this->nodes_) {
-      msgBuffer << node->id << "(" << node->level << "," << node->position << ") ";
-    }
-    XBT_DEBUG("%s", msgBuffer.str().c_str());
+  msgBuffer << "We are creating a fat tree of " << this->levels_ << " levels "
+            << "with " << this->nodes_by_level_[0] << " processing nodes";
+  for (unsigned int i = 1; i <= this->levels_; i++) {
+    msgBuffer << ", " << this->nodes_by_level_[i] << " switches at level " << i;
   }
+  XBT_DEBUG("%s", msgBuffer.str().c_str());
+  msgBuffer.str("");
+  msgBuffer << "Nodes are : ";
 
-  this->generate_labels();
-
-  unsigned int k = 0;
-  // Nodes are totally ordered, by level and then by position, in this->nodes
-  for (unsigned int i = 0; i < this->levels_; i++) {
-    for (unsigned int j = 0; j < this->nodes_by_level_[i]; j++) {
-      this->connect_node_to_parents(this->nodes_[k]);
-      k++;
-    }
+  for (auto const& node : this->nodes_) {
+    msgBuffer << node->id << "(" << node->level << "," << node->position << ") ";
   }
+  XBT_DEBUG("%s", msgBuffer.str().c_str());
 
-  if (XBT_LOG_ISENABLED(surf_route_fat_tree, xbt_log_priority_debug)) {
-    std::stringstream msgBuffer;
-    msgBuffer << "Links are : ";
-    for (FatTreeLink const* link : this->links_) {
-      msgBuffer << "(" << link->up_node_->id << "," << link->down_node_->id << ") ";
-    }
-    XBT_DEBUG("%s", msgBuffer.str().c_str());
+  msgBuffer.clear();
+  msgBuffer << "Links are : ";
+  for (auto const& link : this->links_) {
+    msgBuffer << "(" << link->up_node_->id << "," << link->down_node_->id << ") ";
   }
+  XBT_DEBUG("%s", msgBuffer.str().c_str());
 }
 
 int FatTreeZone::connect_node_to_parents(FatTreeNode* node)
@@ -179,13 +172,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++;
@@ -199,7 +192,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++) {
@@ -227,7 +220,7 @@ bool FatTreeZone::are_related(FatTreeNode* parent, FatTreeNode* child) const
   return true;
 }
 
-void FatTreeZone::generate_switches()
+void FatTreeZone::generate_switches(const s4u::ClusterCallbacks& set_callbacks)
 {
   XBT_DEBUG("Generating switches.");
   this->nodes_by_level_.resize(this->levels_ + 1, 0);
@@ -255,18 +248,31 @@ void FatTreeZone::generate_switches()
     this->nodes_by_level_[i + 1] = nodesInThisLevel;
   }
 
+  /* 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();
+      }
+    }
+    return limiter;
+  };
   // 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++) {
-      auto* newNode = new FatTreeNode(--k, i + 1, j, nullptr, nullptr);
+  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);
     }
   }
 }
@@ -285,7 +291,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 <";
@@ -327,15 +333,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->nodes_.emplace_back(newNode);
 }
 
 void FatTreeZone::add_link(FatTreeNode* parent, unsigned int parentPort, FatTreeNode* child, unsigned int childPort)
@@ -346,22 +353,22 @@ void FatTreeZone::add_link(FatTreeNode* parent, unsigned int parentPort, FatTree
   std::string id =
       "link_from_" + std::to_string(child->id) + "_" + std::to_string(parent->id) + "_" + std::to_string(uniqueId);
 
-  if (link_sharing_policy_ == s4u::Link::SharingPolicy::SPLITDUPLEX) {
-    linkup   = create_link(id + "_UP", std::vector<double>{link_bw_})->set_latency(link_lat_)->seal();
-    linkdown = create_link(id + "_DOWN", std::vector<double>{link_bw_})->set_latency(link_lat_)->seal();
+  if (get_link_sharing_policy() == s4u::Link::SharingPolicy::SPLITDUPLEX) {
+    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>{link_bw_})->set_latency(link_lat_)->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,
@@ -388,13 +395,6 @@ void FatTreeZone::check_topology(unsigned int n_levels, const std::vector<unsign
   check_vector(link_count, "link count");
 }
 
-void FatTreeZone::set_link_characteristics(double bw, double lat, s4u::Link::SharingPolicy sharing_policy)
-{
-  link_sharing_policy_ = sharing_policy;
-  link_bw_             = bw;
-  link_lat_            = lat;
-}
-
 void FatTreeZone::set_topology(unsigned int n_levels, const std::vector<unsigned int>& down_links,
                                const std::vector<unsigned int>& up_links, const std::vector<unsigned int>& link_count)
 {
@@ -404,7 +404,7 @@ void FatTreeZone::set_topology(unsigned int n_levels, const std::vector<unsigned
   num_port_lower_level_  = link_count;
 }
 
-void FatTreeZone::parse_specific_arguments(ClusterCreationArgs* cluster)
+s4u::FatTreeParams FatTreeZone::parse_topo_parameters(const std::string& topo_parameters)
 {
   std::vector<std::string> parameters;
   std::vector<std::string> tmp;
@@ -412,7 +412,7 @@ void FatTreeZone::parse_specific_arguments(ClusterCreationArgs* cluster)
   std::vector<unsigned int> down;
   std::vector<unsigned int> up;
   std::vector<unsigned int> count;
-  boost::split(parameters, cluster->topo_parameters, boost::is_any_of(";"));
+  boost::split(parameters, topo_parameters, boost::is_any_of(";"));
 
   surf_parse_assert(
       parameters.size() == 4,
@@ -464,12 +464,7 @@ void FatTreeZone::parse_specific_arguments(ClusterCreationArgs* cluster)
       throw std::invalid_argument(std::string("Invalid lower level port number:") + port);
     }
   }
-
-  /* set topology */
-  FatTreeZone::check_topology(n_lev, down, up, count);
-  set_topology(n_lev, down, up, count);
-  /* saving internal links properties */
-  set_link_characteristics(cluster->bw, cluster->lat, cluster->sharing_policy);
+  return s4u::FatTreeParams(n_lev, down, up, count);
 }
 
 void FatTreeZone::generate_dot_file(const std::string& filename) const
@@ -479,7 +474,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";
@@ -487,7 +482,7 @@ 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 << "}";
@@ -505,10 +500,8 @@ FatTreeParams::FatTreeParams(unsigned int n_levels, const std::vector<unsigned i
 }
 
 NetZone* create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& params,
-                             double bandwidth, double latency, Link::SharingPolicy sharing_policy,
-                             const std::function<ClusterNetPointCb>& set_netpoint,
-                             const std::function<ClusterLinkCb>& set_loopback,
-                             const std::function<ClusterLinkCb>& set_limiter)
+                             const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
+                             Link::SharingPolicy sharing_policy)
 {
   /* initial checks */
   if (bandwidth <= 0)
@@ -526,14 +519,16 @@ NetZone* create_fatTree_zone(const std::string& name, const NetZone* parent, con
   zone->set_link_characteristics(bandwidth, latency, sharing_policy);
 
   /* populating it */
-  int tot_elements = std::accumulate(params.down.begin(), params.down.end(), 1, std::multiplies<>());
-  for (int i = 0; i < tot_elements; i++) {
+  unsigned int tot_elements = std::accumulate(params.down.begin(), params.down.end(), 1, std::multiplies<>());
+  for (unsigned int i = 0; i < tot_elements; i++) {
     kernel::routing::NetPoint* netpoint;
     Link* limiter;
     Link* loopback;
-    zone->fill_leaf_from_cb(i, params.down, set_netpoint, set_loopback, set_limiter, &netpoint, &loopback, &limiter);
+    /* coordinates are based on 2 indexes: number of levels and id */
+    zone->fill_leaf_from_cb(i, {params.levels + 1, tot_elements}, set_callbacks, &netpoint, &loopback, &limiter);
     zone->add_processing_node(i, limiter ? limiter->get_impl() : nullptr, loopback ? loopback->get_impl() : nullptr);
   }
+  zone->build_upper_levels(set_callbacks);
 
   return zone->get_iface();
 }