src/surf/surf_routing_cluster_torus.cpp

   1 /* Copyright (c) 2014-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "src/surf/surf_routing_private.hpp"
   8 #include "src/surf/surf_routing_cluster_torus.hpp"
   9 #include <surf/surfxml_parse.h> // FIXME: move that back to the parsing area
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_torus, surf_route_cluster, "Torus Routing part of surf");
  12
  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 surf {
  31     AsClusterTorus::AsClusterTorus(const char*name)
  32       : AsCluster(name) {
  33     }
  34     AsClusterTorus::~AsClusterTorus() {
  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       s_sg_platf_link_cbarg_t link = SG_PLATF_LINK_INITIALIZER;
  40       char *link_id;
  41       unsigned int j = 0;
  42       /**
  43        * Create all links that exist in the torus.
  44        * Each rank creates #dimensions-1 links
  45        */
  46       int neighbour_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 neighbour_id
  51       for (j = 0; j < xbt_dynar_length(dimensions_); j++) {
  52
  53         memset(&link, 0, sizeof(link));
  54         current_dimension = xbt_dynar_get_as(dimensions_, j, int);
  55         neighbour_rank_id =
  56             (((int) rank / dim_product) % current_dimension ==
  57                 current_dimension - 1) ? rank - (current_dimension - 1) * dim_product : rank + dim_product;
  58         //name of neighbor is not right for non contiguous cluster radicals (as id != rank in this case)
  59         link_id = bprintf("%s_link_from_%i_to_%i", cluster->id, id, neighbour_rank_id);
  60         link.id = link_id;
  61         link.bandwidth = cluster->bw;
  62         link.latency = cluster->lat;
  63         link.initiallyOn = 1;
  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.link_up = Link::byName(tmp_link);
  70           free(tmp_link);
  71           tmp_link = bprintf("%s_DOWN", link_id);
  72           info.link_down = Link::byName(tmp_link);
  73           free(tmp_link);
  74         } else {
  75           info.link_up = Link::byName(link_id);
  76           info.link_down = info.link_up;
  77         }
  78         /**
  79          * Add the link to its appropriate position;
  80          * note that position rankId*(xbt_dynar_length(dimensions)+has_loopack?+has_limiter?)
  81          * holds the link "rankId->rankId"
  82          */
  83         xbt_dynar_set(upDownLinks, position + j, &info);
  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), NULL);
  98         /**
  99          * We are in a torus cluster
 100          * Parse attribute dimensions="dim1,dim2,dim3,...,dimN"
 101          * and safe it in a dynarray.
 102          * Additionally, we need to know how many ranks we have in total
 103          */
 104         xbt_dynar_foreach(dimensions, iter, groups) {
 105           int tmp = surf_parse_get_int(xbt_dynar_get_as(dimensions, iter, char *));
 106           xbt_dynar_set_as(dimensions_, iter, int, tmp);
 107         }
 108
 109         nb_links_per_node_ = xbt_dynar_length(dimensions_);
 110
 111       }
 112       xbt_dynar_free(&dimensions);
 113     }
 114
 115     void AsClusterTorus::getRouteAndLatency(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t route, double *lat) {
 116
 117       XBT_VERB("torus_get_route_and_latency from '%s'[%d] to '%s'[%d]",
 118           src->name(), src->id(), dst->name(), dst->id());
 119
 120       if (dst->getRcType() == SURF_NETWORK_ELEMENT_ROUTER || src->getRcType() == SURF_NETWORK_ELEMENT_ROUTER)
 121         return;
 122
 123       if ((src->id() == dst->id()) && has_loopback_) {
 124         s_surf_parsing_link_up_down_t info =
 125             xbt_dynar_get_as(upDownLinks, src->id() * nb_links_per_node_, s_surf_parsing_link_up_down_t);
 126         xbt_dynar_push_as(route->link_list, void *, info.link_up);
 127
 128         if (lat)
 129           *lat += static_cast < Link * >(info.link_up)->getLatency();
 130         return;
 131       }
 132
 133
 134       /**
 135        * Dimension based routing routes through each dimension consecutively
 136        * TODO Change to dynamic assignment
 137        */
 138       unsigned int j, cur_dim, dim_product = 1;
 139       int current_node = src->id();
 140       int unsigned next_node = 0;
 141       /**
 142        * Arrays that hold the coordinates of the current node and
 143        * the target; comparing the values at the i-th position of
 144        * both arrays, we can easily assess whether we need to route
 145        * into this dimension or not.
 146        */
 147       unsigned int *myCoords, *targetCoords;
 148       myCoords = rankId_to_coords(src->id(), dimensions_);
 149       targetCoords = rankId_to_coords(dst->id(), dimensions_);
 150       /**
 151        * linkOffset describes the offset where the link
 152        * we want to use is stored
 153        * (+1 is added because each node has a link from itself to itself,
 154        * which can only be the case if src->m_id == dst->m_id -- see above
 155        * for this special case)
 156        */
 157       int nodeOffset = (xbt_dynar_length(dimensions_) + 1) * src->id();
 158
 159       int linkOffset = nodeOffset;
 160       bool use_lnk_up = false;  // Is this link of the form "cur -> next" or "next -> cur"?
 161       // false means: next -> cur
 162       while (current_node != dst->id()) {
 163         dim_product = 1;        // First, we will route in x-dimension
 164         for (j = 0; j < xbt_dynar_length(dimensions_); j++) {
 165           cur_dim = xbt_dynar_get_as(dimensions_, j, int);
 166
 167           // current_node/dim_product = position in current dimension
 168           if ((current_node / dim_product) % cur_dim != (dst->id() / dim_product) % cur_dim) {
 169
 170             if ((targetCoords[j] > myCoords[j] && targetCoords[j] <= myCoords[j] + cur_dim / 2) // Is the target node on the right, without the wrap-around?
 171                 || (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?
 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 * (nb_links_per_node_);
 179               linkOffset = nodeOffset + has_loopback_ + has_limiter_ + 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 * (nb_links_per_node_);
 190               linkOffset = nodeOffset + j + has_loopback_ + has_limiter_;
 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",
 196                 current_node, next_node, linkOffset);
 197
 198             break;
 199           }
 200
 201           dim_product *= cur_dim;
 202         }
 203
 204         s_surf_parsing_link_up_down_t info;
 205
 206         if (has_limiter_) {    // limiter for sender
 207           info = xbt_dynar_get_as(upDownLinks, nodeOffset + has_loopback_, s_surf_parsing_link_up_down_t);
 208           xbt_dynar_push_as(route->link_list, void *, info.link_up);
 209         }
 210
 211         info = xbt_dynar_get_as(upDownLinks, linkOffset, s_surf_parsing_link_up_down_t);
 212
 213         if (use_lnk_up == false) {
 214           xbt_dynar_push_as(route->link_list, void *, info.link_down);
 215
 216           if (lat)
 217             *lat += static_cast < Link * >(info.link_down)->getLatency();
 218         } else {
 219           xbt_dynar_push_as(route->link_list, void *, info.link_up);
 220
 221           if (lat)
 222             *lat += static_cast < Link * >(info.link_up)->getLatency();
 223         }
 224         current_node = next_node;
 225         next_node = 0;
 226       }
 227       free(myCoords);
 228       free(targetCoords);
 229
 230
 231
 232       return;
 233     }
 234
 235   }
 236 }