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
  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(&p_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(p_dimensions); j++) {
  51
  52         memset(&link, 0, sizeof(link));
  53         current_dimension = xbt_dynar_get_as(p_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.initiallyOn = 1;
  63         link.policy = cluster->sharing_policy;
  64         sg_platf_new_link(&link);
  65         s_surf_parsing_link_up_down_t info;
  66         if (link.policy == SURF_LINK_FULLDUPLEX) {
  67           char *tmp_link = bprintf("%s_UP", link_id);
  68           info.link_up = Link::byName(tmp_link);
  69           free(tmp_link);
  70           tmp_link = bprintf("%s_DOWN", link_id);
  71           info.link_down = Link::byName(tmp_link);
  72           free(tmp_link);
  73         } else {
  74           info.link_up = Link::byName(link_id);
  75           info.link_down = info.link_up;
  76         }
  77         /**
  78          * Add the link to its appropriate position;
  79          * note that position rankId*(xbt_dynar_length(dimensions)+has_loopack?+has_limiter?)
  80          * holds the link "rankId->rankId"
  81          */
  82         xbt_dynar_set(upDownLinks, position + j, &info);
  83         dim_product *= current_dimension;
  84         xbt_free(link_id);
  85       }
  86       rank++;
  87     }
  88
  89     void AsClusterTorus::parse_specific_arguments(sg_platf_cluster_cbarg_t cluster) {
  90
  91       unsigned int iter;
  92       char *groups;
  93       xbt_dynar_t dimensions = xbt_str_split(cluster->topo_parameters, ",");
  94
  95       if (!xbt_dynar_is_empty(dimensions)) {
  96         p_dimensions = xbt_dynar_new(sizeof(int), NULL);
  97         /**
  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(p_dimensions, iter, int, tmp);
 106         }
 107
 108         p_nb_links_per_node = xbt_dynar_length(p_dimensions);
 109
 110       }
 111       xbt_dynar_free(&dimensions);
 112     }
 113
 114     void AsClusterTorus::getRouteAndLatency(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t route, double *lat) {
 115
 116       XBT_VERB("torus_get_route_and_latency from '%s'[%d] to '%s'[%d]",
 117           src->getName(), src->getId(), dst->getName(), dst->getId());
 118
 119       if (dst->getRcType() == SURF_NETWORK_ELEMENT_ROUTER || src->getRcType() == SURF_NETWORK_ELEMENT_ROUTER)
 120         return;
 121
 122       if ((src->getId() == dst->getId()) && p_has_loopback) {
 123         s_surf_parsing_link_up_down_t info =
 124             xbt_dynar_get_as(upDownLinks, src->getId() * p_nb_links_per_node, s_surf_parsing_link_up_down_t);
 125         xbt_dynar_push_as(route->link_list, void *, info.link_up);
 126
 127         if (lat)
 128           *lat += static_cast < Link * >(info.link_up)->getLatency();
 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       int current_node = src->getId();
 139       int unsigned 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, *targetCoords;
 147       myCoords = rankId_to_coords(src->getId(), p_dimensions);
 148       targetCoords = rankId_to_coords(dst->getId(), p_dimensions);
 149       /**
 150        * linkOffset describes the offset where the link
 151        * we want to use is stored
 152        * (+1 is added because each node has a link from itself to itself,
 153        * which can only be the case if src->m_id == dst->m_id -- see above
 154        * for this special case)
 155        */
 156       int nodeOffset = (xbt_dynar_length(p_dimensions) + 1) * src->getId();
 157
 158       int linkOffset = nodeOffset;
 159       bool use_lnk_up = false;  // Is this link of the form "cur -> next" or "next -> cur"?
 160       // false means: next -> cur
 161       while (current_node != dst->getId()) {
 162         dim_product = 1;        // First, we will route in x-dimension
 163         for (j = 0; j < xbt_dynar_length(p_dimensions); j++) {
 164           cur_dim = xbt_dynar_get_as(p_dimensions, j, int);
 165
 166           // current_node/dim_product = position in current dimension
 167           if ((current_node / dim_product) % cur_dim != (dst->getId() / dim_product) % cur_dim) {
 168
 169             if ((targetCoords[j] > myCoords[j] && targetCoords[j] <= myCoords[j] + cur_dim / 2) // Is the target node on the right, without the wrap-around?
 170                 || (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?
 171               if ((current_node / dim_product) % cur_dim == cur_dim - 1)
 172                 next_node = (current_node + dim_product - dim_product * cur_dim);
 173               else
 174                 next_node = (current_node + dim_product);
 175
 176               // HERE: We use *CURRENT* node for calculation (as opposed to next_node)
 177               nodeOffset = current_node * (p_nb_links_per_node);
 178               linkOffset = nodeOffset + p_has_loopback + p_has_limiter + j;
 179               use_lnk_up = true;
 180               assert(linkOffset >= 0);
 181             } else {            // Route to the left
 182               if ((current_node / dim_product) % cur_dim == 0)
 183                 next_node = (current_node - dim_product + dim_product * cur_dim);
 184               else
 185                 next_node = (current_node - dim_product);
 186
 187               // HERE: We use *next* node for calculation (as opposed to current_node!)
 188               nodeOffset = next_node * (p_nb_links_per_node);
 189               linkOffset = nodeOffset + j + p_has_loopback + p_has_limiter;
 190               use_lnk_up = false;
 191
 192               assert(linkOffset >= 0);
 193             }
 194             XBT_DEBUG("torus_get_route_and_latency - current_node: %i, next_node: %u, linkOffset is %i",
 195                 current_node, next_node, linkOffset);
 196
 197             break;
 198           }
 199
 200           dim_product *= cur_dim;
 201         }
 202
 203         s_surf_parsing_link_up_down_t info;
 204
 205         if (p_has_limiter) {    // limiter for sender
 206           info = xbt_dynar_get_as(upDownLinks, nodeOffset + p_has_loopback, s_surf_parsing_link_up_down_t);
 207           xbt_dynar_push_as(route->link_list, void *, info.link_up);
 208         }
 209
 210         info = xbt_dynar_get_as(upDownLinks, linkOffset, s_surf_parsing_link_up_down_t);
 211
 212         if (use_lnk_up == false) {
 213           xbt_dynar_push_as(route->link_list, void *, info.link_down);
 214
 215           if (lat)
 216             *lat += static_cast < Link * >(info.link_down)->getLatency();
 217         } else {
 218           xbt_dynar_push_as(route->link_list, void *, info.link_up);
 219
 220           if (lat)
 221             *lat += static_cast < Link * >(info.link_up)->getLatency();
 222         }
 223         current_node = next_node;
 224         next_node = 0;
 225       }
 226       free(myCoords);
 227       free(targetCoords);
 228
 229
 230
 231       return;
 232     }
 233
 234   }
 235 }