Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
do not use RouteCreationArgs outside of XML parsing
[simgrid.git] / src / kernel / routing / FatTreeZone.cpp
index 9e7d2cc..b7df0d1 100644 (file)
@@ -1,9 +1,10 @@
-/* Copyright (c) 2014-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2014-2021. 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 <fstream>
+#include <numeric>
 #include <sstream>
 #include <string>
 
@@ -12,7 +13,6 @@
 #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>
 
@@ -22,23 +22,15 @@ namespace simgrid {
 namespace kernel {
 namespace routing {
 
-FatTreeZone::FatTreeZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel)
-    : ClusterZone(father, name, netmodel)
-{
-  XBT_DEBUG("Creating a new fat tree.");
-}
-
 FatTreeZone::~FatTreeZone()
 {
-  for (unsigned int i = 0; i < this->nodes_.size(); i++) {
-    delete this->nodes_[i];
-  }
-  for (unsigned int i = 0; i < this->links_.size(); i++) {
-    delete this->links_[i];
-  }
+  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)
+bool FatTreeZone::is_in_sub_tree(FatTreeNode* root, 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);
@@ -59,7 +51,7 @@ bool FatTreeZone::is_in_sub_tree(FatTreeNode* root, FatTreeNode* node)
   return true;
 }
 
-void FatTreeZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency)
+void FatTreeZone::get_local_route(NetPoint* src, NetPoint* dst, Route* into, double* latency)
 {
   if (dst->is_router() || src->is_router())
     return;
@@ -79,10 +71,10 @@ void FatTreeZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArg
            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 && this->has_loopback_) {
-    into->link_list.push_back(source->loopback);
+  if (source->id == destination->id && has_loopback()) {
+    into->link_list_.push_back(source->loopback_);
     if (latency)
-      *latency += source->loopback->get_latency();
+      *latency += source->loopback_->get_latency();
     return;
   }
 
@@ -97,13 +89,13 @@ 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_);
+    into->link_list_.push_back(currentNode->parents[d]->up_link_);
 
     if (latency)
       *latency += currentNode->parents[d]->up_link_->get_latency();
 
-    if (this->has_limiter_)
-      into->link_list.push_back(currentNode->limiter_link_);
+    if (currentNode->limiter_link_)
+      into->link_list_.push_back(currentNode->limiter_link_);
     currentNode = currentNode->parents[d]->up_node_;
   }
 
@@ -114,23 +106,26 @@ 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_);
+        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_;
-        if (this->has_limiter_)
-          into->link_list.push_back(currentNode->limiter_link_);
+        if (currentNode->limiter_link_)
+          into->link_list_.push_back(currentNode->limiter_link_);
         XBT_DEBUG("%d(%u,%u) is accessible through %d(%u,%u)", destination->id, destination->level,
                   destination->position, currentNode->id, currentNode->level, currentNode->position);
       }
     }
   }
+  // set gateways (if any)
+  into->gw_src_ = get_gateway(src->id());
+  into->gw_dst_ = get_gateway(dst->id());
 }
 
 /* This function makes the assumption that parse_specific_arguments() and
  * addNodes() have already been called
  */
-void FatTreeZone::seal()
+void FatTreeZone::do_seal()
 {
   if (this->levels_ == 0) {
     return;
@@ -149,8 +144,8 @@ void FatTreeZone::seal()
     msgBuffer.str("");
     msgBuffer << "Nodes are : ";
 
-    for (unsigned int i = 0; i < this->nodes_.size(); i++) {
-      msgBuffer << this->nodes_[i]->id << "(" << this->nodes_[i]->level << "," << this->nodes_[i]->position << ") ";
+    for (FatTreeNode const* node : this->nodes_) {
+      msgBuffer << node->id << "(" << node->level << "," << node->position << ") ";
     }
     XBT_DEBUG("%s", msgBuffer.str().c_str());
   }
@@ -169,8 +164,8 @@ void FatTreeZone::seal()
   if (XBT_LOG_ISENABLED(surf_route_fat_tree, xbt_log_priority_debug)) {
     std::stringstream msgBuffer;
     msgBuffer << "Links are : ";
-    for (unsigned int i = 0; i < this->links_.size(); i++) {
-      msgBuffer << "(" << this->links_[i]->up_node_->id << "," << this->links_[i]->down_node_->id << ") ";
+    for (FatTreeLink const* link : this->links_) {
+      msgBuffer << "(" << link->up_node_->id << "," << link->down_node_->id << ") ";
     }
     XBT_DEBUG("%s", msgBuffer.str().c_str());
   }
@@ -178,9 +173,9 @@ void FatTreeZone::seal()
 
 int FatTreeZone::connect_node_to_parents(FatTreeNode* node)
 {
-  std::vector<FatTreeNode*>::iterator currentParentNode = this->nodes_.begin();
-  int connectionsNumber                                 = 0;
-  const int level                                       = node->level;
+  auto currentParentNode = this->nodes_.begin();
+  int connectionsNumber  = 0;
+  const int level        = node->level;
   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++) {
@@ -200,7 +195,7 @@ int FatTreeZone::connect_node_to_parents(FatTreeNode* node)
   return connectionsNumber;
 }
 
-bool FatTreeZone::are_related(FatTreeNode* parent, FatTreeNode* child)
+bool FatTreeZone::are_related(FatTreeNode* parent, FatTreeNode* child) const
 {
   std::stringstream msgBuffer;
 
@@ -264,7 +259,7 @@ void FatTreeZone::generate_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++) {
-      FatTreeNode* newNode = new FatTreeNode(this->cluster_, --k, i + 1, j);
+      auto* newNode = new FatTreeNode(--k, i + 1, j, nullptr, 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]);
       if (i != this->levels_ - 1) {
@@ -332,12 +327,11 @@ int FatTreeZone::get_level_position(const unsigned int level)
   return tempPosition;
 }
 
-void FatTreeZone::add_processing_node(int id)
+void FatTreeZone::add_processing_node(int id, resource::LinkImpl* limiter, resource::LinkImpl* loopback)
 {
   using std::make_pair;
   static int position = 0;
-  FatTreeNode* newNode;
-  newNode = new FatTreeNode(this->cluster_, id, 0, position++);
+  auto* newNode       = new FatTreeNode(id, 0, position++, limiter, loopback);
   newNode->parents.resize(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));
@@ -346,8 +340,24 @@ void FatTreeZone::add_processing_node(int id)
 
 void FatTreeZone::add_link(FatTreeNode* parent, unsigned int parentPort, FatTreeNode* child, unsigned int childPort)
 {
-  FatTreeLink* newLink;
-  newLink = new FatTreeLink(this->cluster_, child, parent);
+  static int uniqueId = 0;
+  const s4u::Link* linkup;
+  const s4u::Link* linkdown;
+  std::string id =
+      "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();
+  } else {
+    linkup   = create_link(id, std::vector<double>{get_link_bandwidth()})->set_latency(get_link_latency())->seal();
+    linkdown = linkup;
+  }
+  uniqueId++;
+
+  auto* newLink = new 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;
@@ -356,64 +366,100 @@ void FatTreeZone::add_link(FatTreeNode* parent, unsigned int parentPort, FatTree
   this->links_.push_back(newLink);
 }
 
-void FatTreeZone::parse_specific_arguments(ClusterCreationArgs* cluster)
+void FatTreeZone::check_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)
+
+{
+  /* check number of levels */
+  if (n_levels == 0)
+    throw std::invalid_argument("FatTreeZone: invalid number of levels, must be > 0");
+
+  auto check_vector = [&n_levels](const std::vector<unsigned int>& vector, const std::string& var_name) {
+    if (vector.size() != n_levels)
+      throw std::invalid_argument("FatTreeZone: invalid " + var_name + " parameter, vector has " +
+                                  std::to_string(vector.size()) + " elements, must have " + std::to_string(n_levels));
+
+    auto check_zero = [](unsigned int i) { return i == 0; };
+    if (std::any_of(vector.begin(), vector.end(), check_zero))
+      throw std::invalid_argument("FatTreeZone: invalid " + var_name + " parameter, all values must be greater than 0");
+  };
+
+  /* check remaining vectors */
+  check_vector(down_links, "down links");
+  check_vector(up_links, "up links");
+  check_vector(link_count, "link count");
+}
+
+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)
+{
+  levels_                = n_levels;
+  num_children_per_node_ = down_links;
+  num_parents_per_node_  = up_links;
+  num_port_lower_level_  = link_count;
+}
+
+s4u::FatTreeParams FatTreeZone::parse_topo_parameters(const std::string& topo_parameters)
 {
   std::vector<std::string> parameters;
   std::vector<std::string> tmp;
-  boost::split(parameters, cluster->topo_parameters, boost::is_any_of(";"));
+  unsigned int n_lev = 0;
+  std::vector<unsigned int> down;
+  std::vector<unsigned int> up;
+  std::vector<unsigned int> count;
+  boost::split(parameters, topo_parameters, boost::is_any_of(";"));
 
-  // TODO : we have to check for zeros and negative numbers, or it might crash
   surf_parse_assert(
       parameters.size() == 4,
       "Fat trees are defined by the levels number and 3 vectors, see the documentation for more information.");
 
   // The first parts of topo_parameters should be the levels number
   try {
-    this->levels_ = std::stoi(parameters[0]);
+    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]);
   }
 
   // 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() == this->levels_, std::string("You specified ") + std::to_string(this->levels_) +
-                                                     " levels but the child count vector (the first one) contains " +
-                                                     std::to_string(tmp.size()) + " levels.");
+  surf_parse_assert(tmp.size() == n_lev, std::string("You specified ") + std::to_string(n_lev) +
+                                             " levels but the child count vector (the first one) contains " +
+                                             std::to_string(tmp.size()) + " levels.");
 
-  for (size_t i = 0; i < tmp.size(); i++) {
+  for (std::string const& level : tmp) {
     try {
-      this->num_children_per_node_.push_back(std::stoi(tmp[i]));
+      down.push_back(std::stoi(level));
     } catch (const std::invalid_argument&) {
-      surf_parse_error(std::string("Invalid child count: ") + tmp[i]);
+      surf_parse_error(std::string("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() == this->levels_, std::string("You specified ") + std::to_string(this->levels_) +
-                                                     " levels but the parent count vector (the second one) contains " +
-                                                     std::to_string(tmp.size()) + " levels.");
-  for (size_t i = 0; i < tmp.size(); i++) {
+  surf_parse_assert(tmp.size() == n_lev, std::string("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 {
-      this->num_parents_per_node_.push_back(std::stoi(tmp[i]));
+      up.push_back(std::stoi(parent));
     } catch (const std::invalid_argument&) {
-      surf_parse_error(std::string("Invalid parent count: ") + tmp[i]);
+      surf_parse_error(std::string("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() == this->levels_, std::string("You specified ") + std::to_string(this->levels_) +
-                                                     " levels but the port count vector (the third one) contains " +
-                                                     std::to_string(tmp.size()) + " levels.");
-  for (size_t i = 0; i < tmp.size(); i++) {
+  surf_parse_assert(tmp.size() == n_lev, std::string("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 {
-      this->num_port_lower_level_.push_back(std::stoi(tmp[i]));
+      count.push_back(std::stoi(port));
     } catch (const std::invalid_argument&) {
-      throw std::invalid_argument(std::string("Invalid lower level port number:") + tmp[i]);
+      throw std::invalid_argument(std::string("Invalid lower level port number:") + port);
     }
   }
-  this->cluster_ = cluster;
+  return s4u::FatTreeParams(n_lev, down, up, count);
 }
 
 void FatTreeZone::generate_dot_file(const std::string& filename) const
@@ -423,64 +469,62 @@ 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 (unsigned int i = 0; i < this->nodes_.size(); i++) {
-    file << this->nodes_[i]->id;
-    if (this->nodes_[i]->id < 0)
+  for (FatTreeNode const* node : this->nodes_) {
+    file << node->id;
+    if (node->id < 0)
       file << " [shape=circle];\n";
     else
       file << " [shape=hexagon];\n";
   }
 
-  for (unsigned int i = 0; i < this->links_.size(); i++) {
-    file << this->links_[i]->down_node_->id << " -- " << this->links_[i]->up_node_->id << ";\n";
+  for (FatTreeLink const* link : this->links_) {
+    file << link->down_node_->id << " -- " << link->up_node_->id << ";\n";
   }
   file << "}";
   file.close();
 }
+} // namespace routing
+} // namespace kernel
 
-FatTreeNode::FatTreeNode(const ClusterCreationArgs* cluster, int id, int level, int position)
-    : id(id), level(level), position(position)
+namespace s4u {
+FatTreeParams::FatTreeParams(unsigned int n_levels, const std::vector<unsigned int>& down_links,
+                             const std::vector<unsigned int>& up_links, const std::vector<unsigned int>& links_number)
+    : levels(n_levels), down(down_links), up(up_links), number(links_number)
 {
-  LinkCreationArgs linkTemplate;
-  if (cluster->limiter_link) {
-    linkTemplate.bandwidths.push_back(cluster->limiter_link);
-    linkTemplate.latency   = 0;
-    linkTemplate.policy    = s4u::Link::SharingPolicy::SHARED;
-    linkTemplate.id        = "limiter_"+std::to_string(id);
-    sg_platf_new_link(&linkTemplate);
-    this->limiter_link_ = s4u::Link::by_name(linkTemplate.id)->get_impl();
-  }
-  if (cluster->loopback_bw || cluster->loopback_lat) {
-    linkTemplate.bandwidths.push_back(cluster->loopback_bw);
-    linkTemplate.latency   = cluster->loopback_lat;
-    linkTemplate.policy    = s4u::Link::SharingPolicy::FATPIPE;
-    linkTemplate.id        = "loopback_"+ std::to_string(id);
-    sg_platf_new_link(&linkTemplate);
-    this->loopback = s4u::Link::by_name(linkTemplate.id)->get_impl();
-  }
+  kernel::routing::FatTreeZone::check_topology(levels, down, up, number);
 }
 
-FatTreeLink::FatTreeLink(const ClusterCreationArgs* cluster, FatTreeNode* downNode, FatTreeNode* upNode)
-    : up_node_(upNode), down_node_(downNode)
+NetZone* create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& params,
+                             const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
+                             Link::SharingPolicy sharing_policy)
 {
-  static int uniqueId = 0;
-  LinkCreationArgs linkTemplate;
-  linkTemplate.bandwidths.push_back(cluster->bw);
-  linkTemplate.latency   = cluster->lat;
-  linkTemplate.policy    = cluster->sharing_policy; // sthg to do with that ?
-  linkTemplate.id =
-      "link_from_" + std::to_string(downNode->id) + "_" + std::to_string(upNode->id) + "_" + std::to_string(uniqueId);
-  sg_platf_new_link(&linkTemplate);
-
-  if (cluster->sharing_policy == s4u::Link::SharingPolicy::SPLITDUPLEX) {
-    this->up_link_   = s4u::Link::by_name(linkTemplate.id + "_UP")->get_impl();   // check link?
-    this->down_link_ = s4u::Link::by_name(linkTemplate.id + "_DOWN")->get_impl(); // check link ?
-  } else {
-    this->up_link_   = s4u::Link::by_name(linkTemplate.id)->get_impl();
-    this->down_link_ = this->up_link_;
+  /* initial checks */
+  if (bandwidth <= 0)
+    throw std::invalid_argument("FatTreeZone: incorrect bandwidth for internode communication, bw=" +
+                                std::to_string(bandwidth));
+  if (latency < 0)
+    throw std::invalid_argument("FatTreeZone: incorrect latency for internode communication, lat=" +
+                                std::to_string(latency));
+
+  /* creating zone */
+  auto* zone = new kernel::routing::FatTreeZone(name);
+  zone->set_topology(params.levels, params.down, params.up, params.number);
+  if (parent)
+    zone->set_parent(parent->get_impl());
+  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++) {
+    kernel::routing::NetPoint* netpoint;
+    Link* limiter;
+    Link* loopback;
+    zone->fill_leaf_from_cb(i, params.down, set_callbacks, &netpoint, &loopback, &limiter);
+    zone->add_processing_node(i, limiter ? limiter->get_impl() : nullptr, loopback ? loopback->get_impl() : nullptr);
   }
-  uniqueId++;
+
+  return zone->get_iface();
 }
-} // namespace routing
-} // namespace kernel
+} // namespace s4u
+
 } // namespace simgrid