src/kernel/routing/AsClusterTorus.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/AsClusterTorus.hpp"
   7 #include "src/kernel/routing/NetCard.hpp"
   8
   9 #include "src/surf/network_interface.hpp"
  10 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_torus, surf_route_cluster, "Torus Routing part of surf");
  13
  14 inline unsigned int *rankId_to_coords(int rankId, xbt_dynar_t dimensions)
  15 {
  16
  17   unsigned int i = 0, cur_dim_size = 1, dim_size_product = 1;
  18   unsigned int *coords = (unsigned int *) malloc(xbt_dynar_length(dimensions) * sizeof(unsigned int));
  19   for (i = 0; i < xbt_dynar_length(dimensions); i++) {
  20     cur_dim_size = xbt_dynar_get_as(dimensions, i, int);
  21     coords[i] = (rankId / dim_size_product) % cur_dim_size;
  22     dim_size_product *= cur_dim_size;
  23   }
  24
  25   return coords;
  26 }
  27
  28
  29 namespace simgrid {
  30   namespace kernel {
  31   namespace routing {
  32   AsClusterTorus::AsClusterTorus(As* father, const char* name) : AsCluster(father, name)
  33   {
  34     }
  35     AsClusterTorus::~AsClusterTorus() {
  36       xbt_dynar_free(&dimensions_);
  37     }
  38
  39     void AsClusterTorus::create_links_for_node(sg_platf_cluster_cbarg_t cluster, int id, int rank, int position) {
  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         s_surf_parsing_link_up_down_t info;
  67         if (link.policy == SURF_LINK_FULLDUPLEX) {
  68           char *tmp_link = bprintf("%s_UP", link_id);
  69           info.linkUp = Link::byName(tmp_link);
  70           free(tmp_link);
  71           tmp_link = bprintf("%s_DOWN", link_id);
  72           info.linkDown = Link::byName(tmp_link);
  73           free(tmp_link);
  74         } else {
  75           info.linkUp = Link::byName(link_id);
  76           info.linkDown = info.linkUp;
  77         }
  78         /*
  79          * Add the link to its appropriate position;
  80          * note that position rankId*(xbt_dynar_length(dimensions)+has_loopback?+has_limiter?)
  81          * holds the link "rankId->rankId"
  82          */
  83         privateLinks_.insert({position + j, {info.linkUp, info.linkDown}});
  84         dim_product *= current_dimension;
  85         xbt_free(link_id);
  86       }
  87       rank++;
  88     }
  89
  90     void AsClusterTorus::parse_specific_arguments(sg_platf_cluster_cbarg_t cluster) {
  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       }
 111       xbt_dynar_free(&dimensions);
 112     }
 113
 114     void AsClusterTorus::getLocalRoute(NetCard* src, NetCard* dst, sg_platf_route_cbarg_t route, double* lat)
 115     {
 116
 117       XBT_VERB("torus getLocalRoute from '%s'[%d] to '%s'[%d]", src->name().c_str(), src->id(), dst->name().c_str(),
 118                dst->id());
 119
 120       if (dst->isRouter() || src->isRouter())
 121         return;
 122
 123       if (src->id() == dst->id() && hasLoopback_) {
 124         std::pair<Link*, Link*> info = privateLinks_.at(src->id() * linkCountPerNode_);
 125
 126         route->link_list->push_back(info.first);
 127         if (lat)
 128           *lat += info.first->latency();
 129         return;
 130       }
 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] && targetCoords[j] <= myCoords[j] + cur_dim / 2) // Is the target node on the right, without the wrap-around?
 169                 || (myCoords[j] > cur_dim / 2 && (myCoords[j] + cur_dim / 2) % cur_dim >= targetCoords[j])) {   // Or do we need to use the wrap around to reach it?
 170               if ((current_node / dim_product) % cur_dim == cur_dim - 1)
 171                 next_node = (current_node + dim_product - dim_product * cur_dim);
 172               else
 173                 next_node = (current_node + dim_product);
 174
 175               // HERE: We use *CURRENT* node for calculation (as opposed to next_node)
 176               nodeOffset = current_node * (linkCountPerNode_);
 177               linkOffset = nodeOffset + (hasLoopback_?1:0) + (hasLimiter_?1:0) + j;
 178               use_lnk_up = true;
 179               assert(linkOffset >= 0);
 180             } else {            // Route to the left
 181               if ((current_node / dim_product) % cur_dim == 0)
 182                 next_node = (current_node - dim_product + dim_product * cur_dim);
 183               else
 184                 next_node = (current_node - dim_product);
 185
 186               // HERE: We use *next* node for calculation (as opposed to current_node!)
 187               nodeOffset = next_node * (linkCountPerNode_);
 188               linkOffset = nodeOffset + j + (hasLoopback_?1:0) + (hasLimiter_?1:0) ;
 189               use_lnk_up = false;
 190
 191               assert(linkOffset >= 0);
 192             }
 193             XBT_DEBUG("torus_get_route_and_latency - current_node: %i, next_node: %u, linkOffset is %i",
 194                 current_node, next_node, linkOffset);
 195
 196             break;
 197           }
 198
 199           dim_product *= cur_dim;
 200         }
 201
 202         std::pair<Link*, Link*> info;
 203
 204         if (hasLimiter_) {    // limiter for sender
 205           info = privateLinks_.at(nodeOffset + hasLoopback_);
 206           route->link_list->push_back(info.first);
 207         }
 208
 209         info = privateLinks_.at(linkOffset);
 210
 211         if (use_lnk_up == false) {
 212           route->link_list->push_back(info.second);
 213           if (lat)
 214             *lat += info.second->latency();
 215         } else {
 216           route->link_list->push_back(info.first);
 217           if (lat)
 218             *lat += info.first->latency();
 219         }
 220         current_node = next_node;
 221         next_node = 0;
 222       }
 223       free(myCoords);
 224       free(targetCoords);
 225
 226       return;
 227     }
 228
 229 }}} // namespace