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