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