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