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", {get_link_bandwidth()})->set_latency(get_link_latency())->seal();
  41       linkdown = create_link(link_id + "_DOWN", {get_link_bandwidth()})->set_latency(get_link_latency())->seal();
  42
  43     } else {
  44       linkup   = create_link(link_id, {get_link_bandwidth()})->set_latency(get_link_latency())->seal();
  45       linkdown = linkup;
  46     }
  47     /*
  48      * Add the link to its appropriate position.
  49      * Note that position rankId*(xbt_dynar_length(dimensions)+has_loopback?+has_limiter?)
  50      * holds the link "rankId->rankId"
  51      */
  52     add_private_link_at(position + j, {linkup->get_impl(), linkdown->get_impl()});
  53     dim_product *= current_dimension;
  54   }
  55 }
  56
  57 std::vector<unsigned int> TorusZone::parse_topo_parameters(const std::string& topo_parameters)
  58 {
  59   std::vector<std::string> dimensions_str;
  60   boost::split(dimensions_str, topo_parameters, boost::is_any_of(","));
  61   std::vector<unsigned int> dimensions;
  62
  63   /* We are in a torus cluster
  64    * Parse attribute dimensions="dim1,dim2,dim3,...,dimN" and save them into a vector.
  65    * Additionally, we need to know how many ranks we have in total
  66    */
  67   std::transform(begin(dimensions_str), end(dimensions_str), std::back_inserter(dimensions),
  68                  [](const std::string& s) { return std::stoi(s); });
  69
  70   return dimensions;
  71 }
  72
  73 void TorusZone::set_topology(const std::vector<unsigned int>& dimensions)
  74 {
  75   xbt_assert(not dimensions.empty(), "Torus dimensions cannot be empty");
  76   dimensions_ = dimensions;
  77   set_num_links_per_node(dimensions_.size());
  78 }
  79
  80 void TorusZone::get_local_route(const NetPoint* src, const NetPoint* dst, Route* route, double* lat)
  81 {
  82   XBT_VERB("torus getLocalRoute from '%s'[%lu] to '%s'[%lu]", src->get_cname(), src->id(), dst->get_cname(), dst->id());
  83
  84   if (dst->is_router() || src->is_router())
  85     return;
  86
  87   if (src->id() == dst->id() && has_loopback()) {
  88     resource::LinkImpl* uplink = get_uplink_from(node_pos(src->id()));
  89
  90     add_link_latency(route->link_list_, uplink, lat);
  91     return;
  92   }
  93
  94   /*
  95    * Dimension based routing routes through each dimension consecutively
  96    * TODO Change to dynamic assignment
  97    */
  98
  99   /*
 100    * Arrays that hold the coordinates of the current node and the target; comparing the values at the i-th position of
 101    * both arrays, we can easily assess whether we need to route into this dimension or not.
 102    */
 103   const unsigned long dsize = dimensions_.size();
 104   std::vector<unsigned int> myCoords(dsize);
 105   std::vector<unsigned int> targetCoords(dsize);
 106   unsigned int dim_size_product = 1;
 107   for (unsigned long i = 0; i < dsize; i++) {
 108     unsigned cur_dim_size = dimensions_[i];
 109     myCoords[i]           = (src->id() / dim_size_product) % cur_dim_size;
 110     targetCoords[i]       = (dst->id() / dim_size_product) % cur_dim_size;
 111     dim_size_product *= cur_dim_size;
 112   }
 113
 114   /*
 115    * linkOffset describes the offset where the link we want to use is stored(+1 is added because each node has a link
 116    * from itself to itself, which can only be the case if src->m_id == dst->m_id -- see above for this special case)
 117    */
 118   unsigned long linkOffset = (dsize + 1) * src->id();
 119
 120   bool use_lnk_up = false; // Is this link of the form "cur -> next" or "next -> cur"? false means: next -> cur
 121   unsigned int current_node = src->id();
 122   while (current_node != dst->id()) {
 123     unsigned int next_node   = 0;
 124     unsigned int dim_product = 1; // First, we will route in x-dimension
 125     for (unsigned j = 0; j < dsize; j++) {
 126       const unsigned cur_dim = dimensions_[j];
 127       // current_node/dim_product = position in current dimension
 128       if ((current_node / dim_product) % cur_dim != (dst->id() / dim_product) % cur_dim) {
 129         if ((targetCoords[j] > myCoords[j] &&
 130              targetCoords[j] <= myCoords[j] + cur_dim / 2) // Is the target node on the right, without the wrap-around?
 131             ||
 132             (myCoords[j] > cur_dim / 2 && (myCoords[j] + cur_dim / 2) % cur_dim >=
 133                                               targetCoords[j])) { // Or do we need to use the wrap around to reach it?
 134           if ((current_node / dim_product) % cur_dim == cur_dim - 1)
 135             next_node = (current_node + dim_product - dim_product * cur_dim);
 136           else
 137             next_node = (current_node + dim_product);
 138
 139           // HERE: We use *CURRENT* node for calculation (as opposed to next_node)
 140           linkOffset = node_pos_with_loopback_limiter(current_node) + j;
 141           use_lnk_up = true;
 142         } else { // Route to the left
 143           if ((current_node / dim_product) % cur_dim == 0)
 144             next_node = (current_node - dim_product + dim_product * cur_dim);
 145           else
 146             next_node = (current_node - dim_product);
 147
 148           // HERE: We use *next* node for calculation (as opposed to current_node!)
 149           linkOffset = node_pos_with_loopback_limiter(next_node) + j;
 150           use_lnk_up = false;
 151         }
 152         XBT_DEBUG("torus_get_route_and_latency - current_node: %u, next_node: %u, linkOffset is %lu", current_node,
 153                   next_node, linkOffset);
 154         break;
 155       }
 156
 157       dim_product *= cur_dim;
 158     }
 159
 160     if (has_limiter()) { // limiter for sender
 161       route->link_list_.push_back(get_uplink_from(node_pos_with_loopback(current_node)));
 162     }
 163
 164     resource::LinkImpl* lnk;
 165     if (use_lnk_up)
 166       lnk = get_uplink_from(linkOffset);
 167     else
 168       lnk = get_downlink_to(linkOffset);
 169
 170     add_link_latency(route->link_list_, lnk, lat);
 171
 172     current_node = next_node;
 173   }
 174   if (has_limiter()) { // limiter for receiver/destination
 175     route->link_list_.push_back(get_downlink_to(node_pos_with_loopback(dst->id())));
 176   }
 177   // set gateways (if any)
 178   route->gw_src_ = get_gateway(src->id());
 179   route->gw_dst_ = get_gateway(dst->id());
 180 }
 181
 182 } // namespace routing
 183 } // namespace kernel
 184
 185 namespace s4u {
 186
 187 NetZone* create_torus_zone(const std::string& name, const NetZone* parent, const std::vector<unsigned int>& dimensions,
 188                            const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
 189                            Link::SharingPolicy sharing_policy)
 190 {
 191   int tot_elements = std::accumulate(dimensions.begin(), dimensions.end(), 1, std::multiplies<>());
 192   if (dimensions.empty() || tot_elements <= 0)
 193     throw std::invalid_argument("TorusZone: incorrect dimensions parameter, each value must be > 0");
 194   if (bandwidth <= 0)
 195     throw std::invalid_argument("TorusZone: incorrect bandwidth for internode communication, bw=" +
 196                                 std::to_string(bandwidth));
 197   if (latency < 0)
 198     throw std::invalid_argument("TorusZone: incorrect latency for internode communication, lat=" +
 199                                 std::to_string(latency));
 200
 201   auto* zone = new kernel::routing::TorusZone(name);
 202   zone->set_topology(dimensions);
 203   if (parent)
 204     zone->set_parent(parent->get_impl());
 205
 206   zone->set_link_characteristics(bandwidth, latency, sharing_policy);
 207
 208   for (int i = 0; i < tot_elements; i++) {
 209     kernel::routing::NetPoint* netpoint;
 210     Link* limiter;
 211     Link* loopback;
 212     zone->fill_leaf_from_cb(i, dimensions, set_callbacks, &netpoint, &loopback, &limiter);
 213
 214     zone->create_torus_links(netpoint->id(), i, zone->node_pos_with_loopback_limiter(netpoint->id()));
 215   }
 216
 217   return zone->get_iface();
 218 }
 219 } // namespace s4u
 220
 221 } // namespace simgrid