src/kernel/routing/TorusZone.cpp

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