src/kernel/routing/TorusZone.cpp

   1 /* Copyright (c) 2014-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/kernel/routing/TorusZone.hpp"
   7 #include "simgrid/kernel/routing/NetPoint.hpp"
   8 #include "src/surf/network_interface.hpp"
   9 #include "src/surf/xml/platf_private.hpp"
  10
  11 #include <boost/algorithm/string/classification.hpp>
  12 #include <boost/algorithm/string/split.hpp>
  13 #include <string>
  14 #include <vector>
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_torus, surf_route_cluster, "Torus Routing part of surf");
  17
  18 namespace simgrid {
  19 namespace kernel {
  20 namespace routing {
  21 TorusZone::TorusZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel)
  22     : ClusterZone(father, name, netmodel)
  23 {
  24 }
  25
  26 void TorusZone::create_links_for_node(ClusterCreationArgs* cluster, int id, int rank, unsigned int position)
  27 {
  28   /* Create all links that exist in the torus. Each rank creates @a dimensions-1 links */
  29   int dim_product = 1; // Needed to calculate the next neighbor_id
  30
  31   for (unsigned int j = 0; j < dimensions_.size(); j++) {
  32     LinkCreationArgs link;
  33     int current_dimension = dimensions_[j]; // which dimension are we currently in?
  34                                             // we need to iterate over all dimensions and create all links there
  35     // The other node the link connects
  36     int neighbor_rank_id = ((rank / dim_product) % current_dimension == current_dimension - 1)
  37                                ? rank - (current_dimension - 1) * dim_product
  38                                : rank + dim_product;
  39     // name of neighbor is not right for non contiguous cluster radicals (as id != rank in this case)
  40     std::string link_id =
  41         std::string(cluster->id) + "_link_from_" + std::to_string(id) + "_to_" + std::to_string(neighbor_rank_id);
  42     link.id        = link_id;
  43     link.bandwidths.push_back(cluster->bw);
  44     link.latency   = cluster->lat;
  45     link.policy    = cluster->sharing_policy;
  46     sg_platf_new_link(&link);
  47     resource::LinkImpl* linkUp;
  48     resource::LinkImpl* linkDown;
  49     if (link.policy == s4u::Link::SharingPolicy::SPLITDUPLEX) {
  50       linkUp   = s4u::Link::by_name(link_id + "_UP")->get_impl();
  51       linkDown = s4u::Link::by_name(link_id + "_DOWN")->get_impl();
  52     } else {
  53       linkUp   = s4u::Link::by_name(link_id)->get_impl();
  54       linkDown = linkUp;
  55     }
  56     /*
  57      * Add the link to its appropriate position.
  58      * Note that position rankId*(xbt_dynar_length(dimensions)+has_loopback?+has_limiter?)
  59      * holds the link "rankId->rankId"
  60      */
  61     private_links_.insert({position + j, {linkUp, linkDown}});
  62     dim_product *= current_dimension;
  63   }
  64   rank++;
  65 }
  66
  67 void TorusZone::parse_specific_arguments(ClusterCreationArgs* cluster)
  68 {
  69   std::vector<std::string> dimensions;
  70   boost::split(dimensions, cluster->topo_parameters, boost::is_any_of(","));
  71
  72   if (not dimensions.empty()) {
  73     /* We are in a torus cluster
  74      * Parse attribute dimensions="dim1,dim2,dim3,...,dimN" and save them into a vector.
  75      * Additionally, we need to know how many ranks we have in total
  76      */
  77     for (auto const& group : dimensions)
  78       dimensions_.push_back(surf_parse_get_int(group));
  79
  80     num_links_per_node_ = dimensions_.size();
  81   }
  82 }
  83
  84 void TorusZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* route, double* lat)
  85 {
  86   XBT_VERB("torus getLocalRoute from '%s'[%u] to '%s'[%u]", src->get_cname(), src->id(), dst->get_cname(), dst->id());
  87
  88   if (dst->is_router() || src->is_router())
  89     return;
  90
  91   if (src->id() == dst->id() && has_loopback_) {
  92     std::pair<resource::LinkImpl*, resource::LinkImpl*> info = private_links_.at(src->id() * num_links_per_node_);
  93
  94     route->link_list.push_back(info.first);
  95     if (lat)
  96       *lat += info.first->get_latency();
  97     return;
  98   }
  99
 100   /*
 101    * Dimension based routing routes through each dimension consecutively
 102    * TODO Change to dynamic assignment
 103    */
 104
 105   /*
 106    * Arrays that hold the coordinates of the current node and the target; comparing the values at the i-th position of
 107    * both arrays, we can easily assess whether we need to route into this dimension or not.
 108    */
 109   const unsigned int dsize = dimensions_.size();
 110   std::vector<unsigned int> myCoords(dsize);
 111   std::vector<unsigned int> targetCoords(dsize);
 112   unsigned int dim_size_product = 1;
 113   for (unsigned i = 0; i < dsize; i++) {
 114     unsigned cur_dim_size = dimensions_[i];
 115     myCoords[i]           = (src->id() / dim_size_product) % cur_dim_size;
 116     targetCoords[i]       = (dst->id() / dim_size_product) % cur_dim_size;
 117     dim_size_product *= cur_dim_size;
 118   }
 119
 120   /*
 121    * linkOffset describes the offset where the link we want to use is stored(+1 is added because each node has a link
 122    * from itself to itself, which can only be the case if src->m_id == dst->m_id -- see above for this special case)
 123    */
 124   int nodeOffset = (dsize + 1) * src->id();
 125
 126   int linkOffset  = nodeOffset;
 127   bool use_lnk_up = false; // Is this link of the form "cur -> next" or "next -> cur"? false means: next -> cur
 128   unsigned int current_node = src->id();
 129   while (current_node != dst->id()) {
 130     unsigned int next_node   = 0;
 131     unsigned int dim_product = 1; // First, we will route in x-dimension
 132     for (unsigned j = 0; j < dsize; j++) {
 133       const unsigned cur_dim = dimensions_[j];
 134       // current_node/dim_product = position in current dimension
 135       if ((current_node / dim_product) % cur_dim != (dst->id() / dim_product) % cur_dim) {
 136         if ((targetCoords[j] > myCoords[j] &&
 137              targetCoords[j] <= myCoords[j] + cur_dim / 2) // Is the target node on the right, without the wrap-around?
 138             || (myCoords[j] > cur_dim / 2 &&
 139                 (myCoords[j] + cur_dim / 2) % cur_dim >=
 140                     targetCoords[j])) { // Or do we need to use the wrap around to reach it?
 141           if ((current_node / dim_product) % cur_dim == cur_dim - 1)
 142             next_node = (current_node + dim_product - dim_product * cur_dim);
 143           else
 144             next_node = (current_node + dim_product);
 145
 146           // HERE: We use *CURRENT* node for calculation (as opposed to next_node)
 147           nodeOffset = current_node * (num_links_per_node_);
 148           linkOffset = nodeOffset + (has_loopback_ ? 1 : 0) + (has_limiter_ ? 1 : 0) + j;
 149           use_lnk_up = true;
 150           assert(linkOffset >= 0);
 151         } else { // Route to the left
 152           if ((current_node / dim_product) % cur_dim == 0)
 153             next_node = (current_node - dim_product + dim_product * cur_dim);
 154           else
 155             next_node = (current_node - dim_product);
 156
 157           // HERE: We use *next* node for calculation (as opposed to current_node!)
 158           nodeOffset = next_node * (num_links_per_node_);
 159           linkOffset = nodeOffset + j + (has_loopback_ ? 1 : 0) + (has_limiter_ ? 1 : 0);
 160           use_lnk_up = false;
 161
 162           assert(linkOffset >= 0);
 163         }
 164         XBT_DEBUG("torus_get_route_and_latency - current_node: %u, next_node: %u, linkOffset is %i", current_node,
 165                   next_node, linkOffset);
 166         break;
 167       }
 168
 169       dim_product *= cur_dim;
 170     }
 171
 172     std::pair<resource::LinkImpl*, resource::LinkImpl*> info;
 173
 174     if (has_limiter_) { // limiter for sender
 175       info = private_links_.at(nodeOffset + (has_loopback_ ? 1 : 0));
 176       route->link_list.push_back(info.first);
 177     }
 178
 179     info = private_links_.at(linkOffset);
 180     resource::LinkImpl* lnk = use_lnk_up ? info.first : info.second;
 181
 182     route->link_list.push_back(lnk);
 183     if (lat)
 184       *lat += lnk->get_latency();
 185
 186     current_node = next_node;
 187   }
 188 }
 189 } // namespace routing
 190 } // namespace kernel
 191 } // namespace simgrid