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