src/kernel/routing/TorusZone.cpp

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