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