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 "simgrid/s4u/Host.hpp"
   9 #include "src/surf/network_interface.hpp"
  10
  11 #include <boost/algorithm/string/classification.hpp>
  12 #include <boost/algorithm/string/split.hpp>
  13 #include <numeric>
  14 #include <string>
  15 #include <vector>
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_torus, surf_route_cluster, "Torus Routing part of surf");
  18
  19 namespace simgrid {
  20 namespace kernel {
  21 namespace routing {
  22
  23 void TorusZone::create_torus_links(int id, int rank, unsigned int position)
  24 {
  25   /* Create all links that exist in the torus. Each rank creates @a dimensions-1 links */
  26   int dim_product = 1; // Needed to calculate the next neighbor_id
  27
  28   for (unsigned int j = 0; j < dimensions_.size(); j++) {
  29     int current_dimension = dimensions_[j]; // which dimension are we currently in?
  30                                             // we need to iterate over all dimensions and create all links there
  31     // The other node the link connects
  32     int neighbor_rank_id = ((rank / dim_product) % current_dimension == current_dimension - 1)
  33                                ? rank - (current_dimension - 1) * dim_product
  34                                : rank + dim_product;
  35     // name of neighbor is not right for non contiguous cluster radicals (as id != rank in this case)
  36     std::string link_id = get_name() + "_link_from_" + std::to_string(id) + "_to_" + std::to_string(neighbor_rank_id);
  37     const s4u::Link* linkup;
  38     const s4u::Link* linkdown;
  39     if (get_link_sharing_policy() == s4u::Link::SharingPolicy::SPLITDUPLEX) {
  40       linkup = create_link(link_id + "_UP", std::vector<double>{get_link_bandwidth()})
  41                    ->set_latency(get_link_latency())
  42                    ->seal();
  43       linkdown = create_link(link_id + "_DOWN", std::vector<double>{get_link_bandwidth()})
  44                      ->set_latency(get_link_latency())
  45                      ->seal();
  46
  47     } else {
  48       linkup = create_link(link_id, std::vector<double>{get_link_bandwidth()})->set_latency(get_link_latency())->seal();
  49       linkdown = linkup;
  50     }
  51     /*
  52      * Add the link to its appropriate position.
  53      * Note that position rankId*(xbt_dynar_length(dimensions)+has_loopback?+has_limiter?)
  54      * holds the link "rankId->rankId"
  55      */
  56     add_private_link_at(position + j, {linkup->get_impl(), linkdown->get_impl()});
  57     dim_product *= current_dimension;
  58   }
  59 }
  60
  61 std::vector<unsigned int> TorusZone::parse_topo_parameters(const std::string& topo_parameters)
  62 {
  63   std::vector<std::string> dimensions_str;
  64   boost::split(dimensions_str, topo_parameters, boost::is_any_of(","));
  65   std::vector<unsigned int> dimensions;
  66
  67   if (not dimensions_str.empty()) {
  68     /* We are in a torus cluster
  69      * Parse attribute dimensions="dim1,dim2,dim3,...,dimN" and save them into a vector.
  70      * Additionally, we need to know how many ranks we have in total
  71      */
  72     std::transform(begin(dimensions_str), end(dimensions_str), std::back_inserter(dimensions),
  73                    [](const std::string& s) { return std::stoi(s); });
  74   }
  75   return dimensions;
  76 }
  77
  78 void TorusZone::set_topology(const std::vector<unsigned int>& dimensions)
  79 {
  80   xbt_assert(not dimensions.empty(), "Torus dimensions cannot be empty");
  81   dimensions_ = dimensions;
  82   set_num_links_per_node(dimensions_.size());
  83 }
  84
  85 void TorusZone::get_local_route(NetPoint* src, NetPoint* dst, Route* route, double* lat)
  86 {
  87   XBT_VERB("torus getLocalRoute from '%s'[%u] to '%s'[%u]", src->get_cname(), src->id(), dst->get_cname(), dst->id());
  88
  89   if (dst->is_router() || src->is_router())
  90     return;
  91
  92   if (src->id() == dst->id() && has_loopback()) {
  93     resource::LinkImpl* uplink = get_uplink_from(node_pos(src->id()));
  94
  95     route->link_list_.push_back(uplink);
  96     if (lat)
  97       *lat += uplink->get_latency();
  98     return;
  99   }
 100
 101   /*
 102    * Dimension based routing routes through each dimension consecutively
 103    * TODO Change to dynamic assignment
 104    */
 105
 106   /*
 107    * Arrays that hold the coordinates of the current node and the target; comparing the values at the i-th position of
 108    * both arrays, we can easily assess whether we need to route into this dimension or not.
 109    */
 110   const unsigned long dsize = dimensions_.size();
 111   std::vector<unsigned int> myCoords(dsize);
 112   std::vector<unsigned int> targetCoords(dsize);
 113   unsigned int dim_size_product = 1;
 114   for (unsigned long i = 0; i < dsize; i++) {
 115     unsigned cur_dim_size = dimensions_[i];
 116     myCoords[i]           = (src->id() / dim_size_product) % cur_dim_size;
 117     targetCoords[i]       = (dst->id() / dim_size_product) % cur_dim_size;
 118     dim_size_product *= cur_dim_size;
 119   }
 120
 121   /*
 122    * linkOffset describes the offset where the link we want to use is stored(+1 is added because each node has a link
 123    * from itself to itself, which can only be the case if src->m_id == dst->m_id -- see above for this special case)
 124    */
 125   int linkOffset = (dsize + 1) * src->id();
 126
 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             ||
 139             (myCoords[j] > cur_dim / 2 && (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           linkOffset = node_pos_with_loopback_limiter(current_node) + j;
 148           use_lnk_up = true;
 149           assert(linkOffset >= 0);
 150         } else { // Route to the left
 151           if ((current_node / dim_product) % cur_dim == 0)
 152             next_node = (current_node - dim_product + dim_product * cur_dim);
 153           else
 154             next_node = (current_node - dim_product);
 155
 156           // HERE: We use *next* node for calculation (as opposed to current_node!)
 157           linkOffset = node_pos_with_loopback_limiter(next_node) + j;
 158           use_lnk_up = false;
 159
 160           assert(linkOffset >= 0);
 161         }
 162         XBT_DEBUG("torus_get_route_and_latency - current_node: %u, next_node: %u, linkOffset is %i", current_node,
 163                   next_node, linkOffset);
 164         break;
 165       }
 166
 167       dim_product *= cur_dim;
 168     }
 169
 170     if (has_limiter()) { // limiter for sender
 171       route->link_list_.push_back(get_uplink_from(node_pos_with_loopback(current_node)));
 172     }
 173
 174     resource::LinkImpl* lnk;
 175     if (use_lnk_up)
 176       lnk = get_uplink_from(linkOffset);
 177     else
 178       lnk = get_downlink_to(linkOffset);
 179
 180     route->link_list_.push_back(lnk);
 181     if (lat)
 182       *lat += lnk->get_latency();
 183
 184     current_node = next_node;
 185   }
 186   if (has_limiter()) { // limiter for receiver/destination
 187     route->link_list_.push_back(get_downlink_to(node_pos_with_loopback(dst->id())));
 188   }
 189   // set gateways (if any)
 190   route->gw_src_ = get_gateway(src->id());
 191   route->gw_dst_ = get_gateway(dst->id());
 192 }
 193
 194 } // namespace routing
 195 } // namespace kernel
 196
 197 namespace s4u {
 198
 199 NetZone* create_torus_zone(const std::string& name, const NetZone* parent, const std::vector<unsigned int>& dimensions,
 200                            const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
 201                            Link::SharingPolicy sharing_policy)
 202 {
 203   int tot_elements = std::accumulate(dimensions.begin(), dimensions.end(), 1, std::multiplies<>());
 204   if (dimensions.empty() || tot_elements <= 0)
 205     throw std::invalid_argument("TorusZone: incorrect dimensions parameter, each value must be > 0");
 206   if (bandwidth <= 0)
 207     throw std::invalid_argument("TorusZone: incorrect bandwidth for internode communication, bw=" +
 208                                 std::to_string(bandwidth));
 209   if (latency < 0)
 210     throw std::invalid_argument("TorusZone: incorrect latency for internode communication, lat=" +
 211                                 std::to_string(latency));
 212
 213   auto* zone = new kernel::routing::TorusZone(name);
 214   zone->set_topology(dimensions);
 215   if (parent)
 216     zone->set_parent(parent->get_impl());
 217
 218   zone->set_link_characteristics(bandwidth, latency, sharing_policy);
 219
 220   for (int i = 0; i < tot_elements; i++) {
 221     kernel::routing::NetPoint* netpoint;
 222     Link* limiter;
 223     Link* loopback;
 224     zone->fill_leaf_from_cb(i, dimensions, set_callbacks, &netpoint, &loopback, &limiter);
 225
 226     zone->create_torus_links(netpoint->id(), i, zone->node_pos_with_loopback_limiter(netpoint->id()));
 227   }
 228
 229   return zone->get_iface();
 230 }
 231 } // namespace s4u
 232
 233 } // namespace simgrid