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