src/kernel/routing/TorusZone.cpp

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